Skip to content

Commit

Permalink
Merge pull request #6861 from readthedocs/make-dev-docs-visible
Browse files Browse the repository at this point in the history
Make development docs a bit easier to find
  • Loading branch information
ericholscher authored Apr 6, 2020
2 parents 0bd43b4 + 63070e7 commit 8285f9e
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 42 deletions.
34 changes: 2 additions & 32 deletions docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Contributing to development

If you want to deep dive and help out with development on Read the Docs, then
first get the project installed locally according to the
:doc:`Installation Guide <development/install>`. After that is done we
:doc:`Installation Guide </development/install>`. After that is done we
suggest you have a look at tickets in our issue tracker that are labelled `Good
First Issue`_. These are meant to be a great way to get a smooth start and
won't put you in front of the most complex parts of the system.
Expand All @@ -40,9 +40,7 @@ They are simply things that are explained.
If you still didn't find something to work on, search for the `Sprintable`_ label.
Those tickets are meant to be standalone and can be worked on ad-hoc.

When contributing code, then please follow the standard Contribution
Guidelines set forth at `contribution-guide.org`_.

You can read all of our :doc:`/development/index` to understand more the development of Read the Docs. When contributing code, then please follow the standard Contribution Guidelines set forth at `contribution-guide.org`_.

.. _Feature: https://github.com/readthedocs/readthedocs.org/issues?direction=desc&labels=Feature&page=1&sort=updated&state=open
.. _Improvement: https://github.com/readthedocs/readthedocs.org/issues?q=is%3Aopen+is%3Aissue+label%3AImprovement
Expand All @@ -61,34 +59,6 @@ There are guidelines around writing and formatting documentation for the project
For full details, including how to build it, see :doc:`/development/docs`.


Developer documentation
-----------------------

These are guides and helpful documentation to running your own local version of Read the Docs
for development or taking the open source Read the Docs codebase
for your own :doc:`custom installation <custom_installs/index>`.

.. toctree::
:maxdepth: 1

development/standards
development/search
development/architecture
development/tests
development/docs
development/front-end
development/design/index
development/buildenvironments
development/symlinks
development/settings
development/install
development/i18n
development/issue-labels
development/design
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>



Triaging tickets
----------------

Expand Down
30 changes: 22 additions & 8 deletions docs/development/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
:orphan:
Developer documentation
-----------------------

Developer Guide
---------------

If you are developing Read the Docs, then these are the docs for you.
These are guides and helpful documentation to running your own local version of Read the Docs
for development or taking the open source Read the Docs codebase
for your own :doc:`custom installation <custom_installs/index>`.

.. toctree::
:maxdepth: 2
:glob:
:maxdepth: 1

standards
search
architecture
tests
docs
front-end
design/index
buildenvironments
symlinks
settings
install
i18n
issue-labels
design
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>

*
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ of Read the Docs and the larger software documentation ecosystem.

* **Getting involved with Read the Docs**:
:doc:`Contributing <contribute>` |
:doc:`Development setup </development/standards>` |
:doc:`roadmap` |
:doc:`gsoc` |
:doc:`Code of conduct <code-of-conduct>`

* **Policies & Process**:
Expand Down Expand Up @@ -195,6 +195,7 @@ of Read the Docs and the larger software documentation ecosystem.
:caption: About Read the Docs

contribute
development/index
roadmap
gsoc
code-of-conduct
Expand All @@ -216,4 +217,3 @@ of Read the Docs and the larger software documentation ecosystem.
commercial/index

custom_installs/index

0 comments on commit 8285f9e

Please sign in to comment.