53 lines
2.0 KiB
ReStructuredText
53 lines
2.0 KiB
ReStructuredText
Read the Docs Open Source Philosophy
|
|
-------------------------------------
|
|
|
|
Read the Docs is Open Source software.
|
|
We have `licensed <https://github.com/rtfd/readthedocs.org/blob/master/LICENSE>`_ the code base as MIT,
|
|
which provides almost no restrictions on the use of the code.
|
|
|
|
However,
|
|
as a project there are things that we care about more than others.
|
|
We built Read the Docs to support documentation in the Open Source community.
|
|
The code is open for people to contribute to,
|
|
so that they may build features into https://readthedocs.org that they want.
|
|
We also believe sharing the code openly is a valuable learning tool,
|
|
especially for demonstrating how to collaborate and maintain an enormous website.
|
|
|
|
|
|
Official Support
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
The time of the core developers of Read the Docs is limited.
|
|
We provide official support for the following things:
|
|
|
|
* Local development on the Python code base
|
|
* Usage of https://readthedocs.org for Open Source projects
|
|
* Bug fixes in the code base, as it applies to running it on https://readthedocs.org
|
|
|
|
Unsupported
|
|
~~~~~~~~~~~
|
|
|
|
There are use cases that we don't support,
|
|
because it doesn't further our goal of promoting documentation in the Open Source Community.
|
|
|
|
We do not support:
|
|
|
|
* Specific usage of Sphinx and Mkdocs, that don't affect our hosting
|
|
* Custom installations of Read the Docs at your company
|
|
* Installation of Read the Docs on other platforms
|
|
* Any installation issues outside of the Read the Docs Python Code
|
|
|
|
Rationale
|
|
~~~~~~~~~
|
|
|
|
Read the Docs was founded to improve documentation in the Open Source Community.
|
|
We fully recognize and allow the code to be used for internal installs at companies,
|
|
but we will not spend our time supporting it.
|
|
Our time is limited,
|
|
and we want to spend it on the mission that we set out to originally support.
|
|
|
|
If you feel strongly about installing Read the Docs internal to a company,
|
|
we will happily link to third party resources on this topic.
|
|
Please open an issue with a proposal if you want to take on this task.
|
|
|