Questions tagged [documentation]

For questions about the information about a project, specifically the documentation of the source code. Questions can relate to best practices, procedures, policies and more.

Filter by
Sorted by
Tagged with
2
votes
1answer
59 views

How to refer to the license when my code is based on a sample in documentation?

When someone makes a code for their project using a certain library, oftentimes he will refer to the official documentation. But how does he need to think about the license? Assuming I have been ...
2
votes
0answers
47 views

License Comptatibility with GSuite?

Are websites made with Google Sites compatible with GPL 3.0? A prospective user can create a web site with Google Sites using the web editor, but the HTML output, which may be interprited as the ...
1
vote
1answer
34 views

License Selection for An Open Document Project with Codes

I am planning to open some my technical notes with example code snippets. Text will be in Markdown (.md) and reStructuredText (.rst) files. Output document (PDF or HTML) will be generated, let's say ...
1
vote
0answers
60 views

Copy part of GNU FDL-licensed document

I'm writing some documentation for a project of mine. This project depends on a GNU project so I must license it under the GNU GPL. In future, it might be integrated in that GNU project so I'm ...
1
vote
0answers
40 views

Distributing source code with different licenses in a single page

I'm writing a web application (hobby project) that aggregates documentations and source code of arbitrary artifacts (from Maven Central) and (possibly) present them to the user in a single web page, ...
1
vote
1answer
188 views

Is the MIT license suitable for documentation?

On choosealicense.com, there's a section that says: Any open source software license or open license for media (see above) is applicable to software documentation This implies that the MIT license ...
0
votes
2answers
45 views

Preventing proprietary implementations/modifications of an open protocol?

I'm not talking about code here but rather about protocol documentation. If I develop an open protocol and release the documentation for it, how can I release the documentation in a way that: ...
6
votes
1answer
68 views

Is there any particular reason to license docs with CC BY 4.0 rather than MIT?

MIT license can be used for "software and associated documentation files". But a few big open source projects licensed under MIT (for example, dotnetcore, reactjs), explicitly use Creative Commons ...
-1
votes
1answer
50 views

What is the license of the documentation at “https://git-scm.org/docs” [closed]

I would like to reuse some descriptions from https://git-scm.com/docs/ in my own Git instructions manual. This manual will be used commercially. I have found a license for the "Pro Git" book CC-By-NC-...
5
votes
1answer
167 views

How to smoothly handle migrating documentation between hosts when redirects are not possible?

I will describe the situation in a language-agnostic manner, but if you are interested in some specifics I will supply them at the bottom of the question. I have a few open source libraries that have ...
0
votes
1answer
52 views

Using advertisements on my wiki licensed under CC BY-NC-SA

I am working on creating an online localized wiki about Linux programs. I am hosting the documents files on GitHub and I would like to choose an open source license for it. The problem is that I don't ...
0
votes
2answers
78 views

Is there a license that restricts interpretation of the source except to documentation?

I was reading an issue on python-patterns' GitHub repo. Where it was asked Really? I mean, these are simple snippets showing design patterns for learning purposes, none of this code is usable as it ...
3
votes
1answer
21 views

How to ship a documentation wiki with an OS web app

For an open source web application, there should be documentation. Keeping such documentation in a Wiki seems to be an desirable approach because various users can easily contribute to it, explaining ...
3
votes
1answer
364 views

Do packages listed in a package.json file need to be documented individually?

I am trying to understand the general clause contained in most licenses that reads as follows The above copyright notice and this permission notice shall be included in all copies or substantial ...
7
votes
2answers
138 views

Where do I put documentation? How much is necessary?

I'm creating a program in python that simulates an ideal quantum computer. It is on GitHub, and while it is not anywhere near complete yet, I don't know how much documentation I need to include, and ...
3
votes
1answer
64 views

If I'm installing a binary, where do I put the license?

Gitless offers a binary release as well as the source code. Since I've had difficulty with installing from source (one of the dependencies won't build), I downloaded said binary and copied it to /usr/...
5
votes
1answer
328 views

Choosing a License for a Tutorial Site

I apologize in advance for what is probably a dumb question, but I'm trying to do this the right way from the beginning. I'm putting together a coding tutorial site, and my main question boils down ...
6
votes
2answers
85 views

Documentation project containing articles and code examples with different licenses

I'm currently working on an open source collaborative project, and I am still confused regarding licenses, and weeks of research didn't really help me pinpoint my particular case. Let me expose it: ...
2
votes
1answer
36 views

Should project analysis documents be packaged along with software?

Analysis documents can be useful to see how a project has been designed from a more abstract point of view. However, would there be any potential downsides on packaging these along with some software ...
4
votes
1answer
64 views

Image copyright in GNU FDL-licensed documentation

I'm creating the documentation for a small FOSS project of mine. I intend to release such documentation under GNU FDL version 1.3. I have one question, though. Someone else has made a graphic art ...
5
votes
1answer
150 views

Is ANTLR Free Software?

I'm thinking about an example of a popular piece of software to illustrate the difference between Free Software and Open Source Software. ANTLRv4 is an Open Source project and provides an online ...
34
votes
6answers
5k views

How can I get users to read the docs/FAQ before asking new questions?

I created an open source user management system for PHP which is (admittedly) directed towards novice programmers. The idea is to help familiarize "Cowboys from Code Canyon" with the tools and design ...
7
votes
1answer
57 views

Good licence for a new documentation project

I want to publish a lot of documentation on programming and other similar topics I have been writing over the years. The documentation consist of explanations, diagrams, exercises and code examples. ...
10
votes
2answers
558 views

Standard for “CONTRIBUTORS”-style file (format, name, etc?)

In trying to deal with a codebase that was originally proprietary and then open sourced, new contributors are coming along. Each file has names on it (though usually the main author's). At this ...
13
votes
3answers
184 views

How can I get contributors to document properly?

How can an open source project get volunteer contributors to document their contribution properly? Real-world example: We've got an open source project with a scripting interface. Gradually we are ...
3
votes
2answers
44 views

When building an open sourced hardware project what documentation do I need?

From previous experience I know that when making an open source piece of software you often have documentation that moves with the file. Some of these files include: Readme License Changes While ...