Skip to content

Rework documentation index page #5819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 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 <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 Down Expand Up @@ -103,7 +103,35 @@ Contributing to documentation
Documentation for Read the Docs itself is hosted by Read the Docs at https://docs.readthedocs.io (likely the website you are currently reading).

There are guidelines around writing and formatting documentation for the project.
For full details, including how to build it, see :doc:`docs`.
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/install
development/search
development/architecture
development/tests
development/docs
development/design/index
development/standards
development/buildenvironments
development/symlinks
development/settings
development/i18n
development/issue-labels
development/design
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>



Triaging tickets
----------------
Expand Down Expand Up @@ -244,7 +272,7 @@ few more at hand to further categorize issues.
handled during a sprint. They are very focused and encapsulated.

For a full list of available labels and their meanings, see
:doc:`issue-labels`.
:doc:`/development/issue-labels`.

Helpful links for triaging
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/custom_installs/customization.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Customizing your install
========================

Read the Docs has a lot of :doc:`/settings` that help customize your install.
Read the Docs has a lot of :doc:`/development/settings` that help customize your install.
This document will outline some of the more useful ways that these can be combined.

Have a local settings file
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/design.rst → docs/development/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ documentation using the default RTD style.
Contributing
------------

Contributions should follow the :doc:`contribute` guidelines where applicable -- ideally you'll
Contributions should follow the :doc:`../contribute` guidelines where applicable -- ideally you'll
create a pull request against the `Read the Docs GitHub project`_ from your forked repo and include
a brief description of what you added / removed / changed, as well as an attached image (you can just
take a screenshot and drop it into the PR creation form) of the effects of your changes.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ This is a GSoC'19 project.

The final result may look something like this:

.. figure:: ../_static/images/design-docs/in-doc-search-ui/in-doc-search-ui-demo.gif
.. figure:: ../../_static/images/design-docs/in-doc-search-ui/in-doc-search-ui-demo.gif
:align: center
:target: ../_static/images/design-docs/in-doc-search-ui/in-doc-search-ui-demo.gif
:target: ../../_static/images/design-docs/in-doc-search-ui/in-doc-search-ui-demo.gif

Short demo

Expand Down Expand Up @@ -49,7 +49,7 @@ Existing Search Implementation

We have a detailed documentation explaing the underlying architecture of our search backend
and how we index documents to our Elasticsearch index.
You can read about it :doc:`here <../development/search>`.
You can read about it :doc:`here <../search>`.


Proposed Architecture for In-Doc Search UI
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/install.rst → docs/development/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,9 @@ Further steps

By now you can trigger builds on your local environment,
to encapsulate the build process inside a Docker container,
see :doc:`development/buildenvironments`.
see :doc:`buildenvironments`.

For building this documentation,
see :doc:`docs`.

And for setting up for the front end development, see :doc:`development/standards`.
And for setting up for the front end development, see :doc:`standards`.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
157 changes: 0 additions & 157 deletions docs/embed.rst

This file was deleted.

7 changes: 4 additions & 3 deletions docs/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ GitHub, Bitbucket and GitLab Integration

We now support linking by default in the sidebar. It links to the page on your host, which should help people quickly update typos and send pull requests to contribute to project documentation.

More information can be found in the :doc:`vcs` page.
More information can be found in :doc:`guides/vcs`.

Auto-updating
-------------
Expand All @@ -18,14 +18,15 @@ The :doc:`webhooks` page talks about the different ways you can ping RTD to let
Internationalization
--------------------

Read the Docs itself is localized, and we support documentation translated into multiple languages. Read more on the :doc:`localization` and :doc:`i18n` pages.
Read the Docs itself is localized, and we support documentation translated into multiple languages.
Read more on the :doc:`localization` and :doc:`development/i18n` pages.

Canonical URLs
--------------

Canonical URLs give your docs better search performance, by pointing all URLs to one version. This also helps to solve the issues around users landing on outdated versions of documentation.

More information can be found in the :doc:`canonical` page.
More information can be found in the :doc:`guides/canonical` page.

Versions
--------
Expand Down
28 changes: 0 additions & 28 deletions docs/features/embed.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/gsoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ the more likely we are to choose your application!
Getting Started
---------------

The :doc:`/install` doc is probably the best place to get going.
The :doc:`/development/install` doc is probably the best place to get going.
It will walk you through getting a basic environment for Read the Docs setup.

Then you can look through our :doc:`/contribute` doc for information on how to get started contributing to RTD.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/conda.rst → docs/guides/conda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This work was funded by `Clinical Graphics`_ -- many thanks for their support of
Activating Conda
----------------

Conda support is available using a :doc:`config-file/index`, see :ref:`config-file/v2:conda`.
Conda support is available using a :doc:`../config-file/index`, see :ref:`config-file/v2:conda`.

This Conda environment will also have Sphinx and other build time dependencies installed.
It will use the same order of operations that we support currently:
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/guides/specifying-dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Using a conda environment file

If using conda, the dependencies can be specified in the `conda environment file`_: ``environment.yml`` .

More on Read the Doc's conda support: :doc:`/conda`.
More on Read the Doc's conda support: :doc:`conda`.

.. _`pip user guide`: https://pip.pypa.io/en/stable/user_guide/#requirements-files
.. _`conda environment file`: https://conda.io/docs/user-guide/tasks/manage-environments.html
2 changes: 1 addition & 1 deletion docs/vcs.rst → docs/guides/vcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Version Control System Integration

.. note::

We :doc:`plan to implement a new approach <design/theme-context>` regarding the Theme Context as a whole,
We :doc:`plan to implement a new approach </development/design/theme-context>` regarding the Theme Context as a whole,
although the VCS documentation page will still be valid, we prefer the users to move in that direction.


Expand Down
Loading