docs: Decouple refrences from /docs folder
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: I1955201382074eb9e6dd80aadbc456eb09aecb22
diff --git a/docs/contributing/code_review_guide.rst b/docs/contributing/code_review_guide.rst
index 08d72a2..cfc9f4d 100644
--- a/docs/contributing/code_review_guide.rst
+++ b/docs/contributing/code_review_guide.rst
@@ -4,7 +4,7 @@
The purpose of this document is to clarify design items to be reviewed during
the code review process.
-Please contact :doc:`maintainers </docs/contributing/maintainers>` or write an e-mail
+Please contact :doc:`maintainers </contributing/maintainers>` or write an e-mail
thread on the `TF-M mailing list <mailto:tf-m@lists.trustedfirmware.org>`_ for
any questions.
@@ -13,9 +13,9 @@
**********************
The prerequisites before going to the review stage:
-- Read the :doc:`Contributing Process </docs/contributing/contributing_process>`
+- Read the :doc:`Contributing Process </contributing/contributing_process>`
to know basic concepts.
-- Read the :doc:`Source Structure </docs/technical_references/design_docs/source_structure>`
+- Read the :doc:`Source Structure </technical_references/design_docs/source_structure>`
for structure related reference.
The review guidelines consist of these items:
diff --git a/docs/contributing/coding_guide.rst b/docs/contributing/coding_guide.rst
index f208fc0..5b75d36 100644
--- a/docs/contributing/coding_guide.rst
+++ b/docs/contributing/coding_guide.rst
@@ -18,7 +18,7 @@
The guidance below is provided as a help. It isn't meant to be a definitive
list.
-As implied in the :doc:`contributing guide </docs/contributing/contributing_process>`
+As implied in the :doc:`contributing guide </contributing/contributing_process>`
maintainers have the right to decide on what's acceptable in case of any
divergence.
diff --git a/docs/contributing/contributing_process.rst b/docs/contributing/contributing_process.rst
index 60faaec..95afef0 100644
--- a/docs/contributing/contributing_process.rst
+++ b/docs/contributing/contributing_process.rst
@@ -5,7 +5,7 @@
.. Note::
- Please contact :doc:`maintainers </docs/contributing/maintainers>` for any
+ Please contact :doc:`maintainers </contributing/maintainers>` for any
questions.
- Subscribe to `TF-M development
@@ -19,22 +19,22 @@
<https://developer.trustedfirmware.org/maniphest>`_, put as many details as
possible in the description. Add 'Trusted Firmware M' in the 'Tags' field.
- For non-trivial changes, need to follow the design proposal process
- :doc:`Design Proposal Guideline </docs/contributing/tfm_design_proposal_guideline>`
+ :doc:`Design Proposal Guideline </contributing/tfm_design_proposal_guideline>`
for the TF-M project.
- After the design has been accepted by the maintainer(s), a corresponding
patch should be posted; follow guidelines below:
- Clone the TF-M code on your own machine from `TF-M git repository
<https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git>`_.
- - Follow the :doc:`TF-M getting started </docs/getting_started/tfm_getting_started>`,
- :doc:`Build Instructions </docs/technical_references/instructions/tfm_build_instruction>` and
- :doc:`Coding Guide </docs/contributing/coding_guide>` for the TF-M project.
+ - Follow the :doc:`TF-M getting started </getting_started/tfm_getting_started>`,
+ :doc:`Build Instructions </technical_references/instructions/tfm_build_instruction>` and
+ :doc:`Coding Guide </contributing/coding_guide>` for the TF-M project.
- Make your changes in logical chunks to help reviewers. Each commit should
be a separate review and either work properly or be squashed after the
review and before merging.
- Update documentation in docs/ folder if needed.
- Test your changes and add details to the commit description.
- - The code is accepted under :doc:`DCO </docs/contributing/dco>`, Developer
+ - The code is accepted under :doc:`DCO </contributing/dco>`, Developer
Certificate of Origin, so you must add following fields to your
commit description:
@@ -66,7 +66,7 @@
git push https://review.trustedfirmware.org/TF-M/trusted-firmware-m.git HEAD:refs/for/master
-- Add relevant :doc:`maintainers </docs/contributing/maintainers>` for reviewing
+- Add relevant :doc:`maintainers </contributing/maintainers>` for reviewing
the patch.
- You may be asked to provide further details or make additional changes.
- You can discuss further with maintainer(s) by directly over email if
diff --git a/docs/contributing/doc_guidelines.rst b/docs/contributing/doc_guidelines.rst
index 607097d..d5c5967 100644
--- a/docs/contributing/doc_guidelines.rst
+++ b/docs/contributing/doc_guidelines.rst
@@ -20,7 +20,7 @@
- If the patch modifies a present file, the file's style should be followed
- If creating a new file,
- :doc:`integration guide </docs/integration_guide/tfm_integration_guide>` can be used as a reference.
+ :doc:`integration guide </integration_guide/tfm_integration_guide>` can be used as a reference.
- When a new style is to be expressed, consult the `Python Documentation Guidelines`_
*************
@@ -186,8 +186,8 @@
+--------------+--------------+-------------+
Other types of tables such as list-tables and csv-tables are also permitted, as
-seen on :doc:`/docs/getting_started/tfm_getting_started` and
-:doc:`/docs/releases/1.0`
+seen on :doc:`/getting_started/tfm_getting_started` and
+:doc:`/releases/1.0`
External Links
@@ -236,7 +236,7 @@
.. code-block:: restructuredtext
- :doc:`integration guide </docs/integration_guide/tfm_integration_guide>`
+ :doc:`integration guide </integration_guide/tfm_integration_guide>`
The path is relative to the root of the Trusted Firmware-M code.
@@ -260,7 +260,7 @@
=============
For technical terms and abbreviations, the recommended guidance is to add an
-entry to the :doc:`/docs/glossary` and refer to it, using the `term:`
+entry to the :doc:`/glossary` and refer to it, using the `term:`
directive
@@ -293,7 +293,7 @@
.. _Sphinx: https://www.sphinx-doc.org/en/master/
.. _Restructed Text: https://docutils.sourceforge.io/rst.html
.. _Python Documentation Guidelines: https://devguide.python.org/documenting/#style-guide
-.. _Pygments Lexers: https://pygments.org/docs/lexers/
+.. _Pygments Lexers: https://pygments.org/lexers/
--------------
diff --git a/docs/contributing/tfm_design_proposal_guideline.rst b/docs/contributing/tfm_design_proposal_guideline.rst
index 14f3804..9e7dfa0 100755
--- a/docs/contributing/tfm_design_proposal_guideline.rst
+++ b/docs/contributing/tfm_design_proposal_guideline.rst
@@ -111,7 +111,7 @@
.. [3] `TF-M gerrit <https://review.trustedfirmware.org/q/project:TF-M/trusted-firmware-m>`_
-.. [4] :doc:`Contributing process </docs/contributing/contributing_process>`
+.. [4] :doc:`Contributing process </contributing/contributing_process>`
-------------------