Changeset View
Changeset View
Standalone View
Standalone View
docs/index.rst
.. _swh-docs: | .. _swh-docs: | ||||
Software Heritage - Development Documentation | Software Heritage - Development Documentation | ||||
============================================= | ============================================= | ||||
Getting started | Getting started | ||||
--------------- | --------------- | ||||
* :ref:`getting-started` → deploy a local copy of the Software Heritage | * :ref:`getting-started` → deploy a local copy of the Software Heritage | ||||
software stack in less than 5 minutes, or | software stack in less than 5 minutes, or | ||||
* :ref:`developer-setup` → get a working development setup that allows to hack | * :ref:`developer-setup` → get a working development setup that allows to hack | ||||
on the Software Heritage software stack | on the Software Heritage software stack | ||||
* :ref:`faq` | |||||
Contributing | Contributing | ||||
------------ | ------------ | ||||
* :ref:`patch-submission` → learn how to submit your patches to the | * :ref:`patch-submission` → learn how to submit your patches to the | ||||
Software Heritage codebase | Software Heritage codebase | ||||
* :ref:`code-review` → rules and guidelines to review code in | * :ref:`code-review` → rules and guidelines to review code in | ||||
Software Heritage | Software Heritage | ||||
Show All 23 Lines | |||||
* :ref:`testing-guide` | * :ref:`testing-guide` | ||||
* :doc:`/tutorials/issue-debugging-monitoring` | * :doc:`/tutorials/issue-debugging-monitoring` | ||||
* :ref:`Listing the content of your favorite forge <lister-tutorial>` | * :ref:`Listing the content of your favorite forge <lister-tutorial>` | ||||
and :ref:`running a lister in Docker <run-lister-tutorial>` | and :ref:`running a lister in Docker <run-lister-tutorial>` | ||||
* :ref:`Add a new swh package <tutorial-new-package>` | * :ref:`Add a new swh package <tutorial-new-package>` | ||||
* :ref:`doc-contribution` | * :ref:`doc-contribution` | ||||
Frequently Asked Questions | |||||
-------------------------- | |||||
.. toctree:: | |||||
:maxdepth: 2 | |||||
faq/index | |||||
Roadmap | Roadmap | ||||
------- | ------- | ||||
* :ref:`roadmap-2021` | * :ref:`roadmap-2021` | ||||
Engineering | Engineering | ||||
----------- | ----------- | ||||
ardumont: I had something like that locally but that saddens me to duplicate entries already present in… | |||||
Done Inline ActionsI did not find a better solution. We could also simply link to the faq page to avoid duplicating the toctree by hand but then we will have FAQ => FAQ which is also not great. anlambert: I did not find a better solution. We could also simply link to the faq page to avoid… | |||||
Done Inline ActionsHow about moving the link to the FAQ in the "Getting started" section then ? anlambert: How about moving the link to the FAQ in the "Getting started" section then ? | |||||
Not Done Inline Actionssounds like a good plan. ardumont: sounds like a good plan. | |||||
* :ref:`infrastructure` | * :ref:`infrastructure` | ||||
Components | Components | ||||
---------- | ---------- | ||||
Here is brief overview of the most relevant software components in the Software | Here is brief overview of the most relevant software components in the Software | ||||
Heritage stack, in alphabetical order. | Heritage stack, in alphabetical order. | ||||
▲ Show 20 Lines • Show All 168 Lines • Show Last 20 Lines |
I had something like that locally but that saddens me to duplicate entries already present in the faq/index..
I don't see anything better so ok ;)
Thanks.