Doc: Updated Document paths
This patch modifes the documentation
in the following ways:
* Contributing, glossary and maintainers
files, are moved into the
the documentation directory
* The table of contents in index.rst.in are
updated accordingly
* Coding_guide, contributing, maintainers and
readme documetns, are updated accordingly
Change-Id: I40ea47f7f154142f1f02f4492ad53c3533109bb0
Signed-off-by: Galanakis, Minos <minos.galanakis@arm.com>
diff --git a/docs/coding_guide.rst b/docs/coding_guide.rst
index 166442a..aefb2b7 100644
--- a/docs/coding_guide.rst
+++ b/docs/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 </contributing>` maintainers
+As implied in the :doc:`contributing guide </docs/contributing>` maintainers
have the right to decide on what's acceptable in case of any divergence.
.. Warning::
diff --git a/contributing.rst b/docs/contributing.rst
similarity index 95%
rename from contributing.rst
rename to docs/contributing.rst
index 691dcde..f1e5b08 100644
--- a/contributing.rst
+++ b/docs/contributing.rst
@@ -3,7 +3,7 @@
Contributions to TF-M project need to follow the process below.
-``Note`` Please contact :doc:`maintainers` for any questions.
+``Note`` Please contact :doc:`/docs/maintainers` for any questions.
- Create an issue in http://issues.trustedfirmware.org
to keep others informed about your ongoing work.
diff --git a/glossary.rst b/docs/glossary.rst
similarity index 100%
rename from glossary.rst
rename to docs/glossary.rst
diff --git a/docs/index.rst.in b/docs/index.rst.in
index 534118f..32355cc 100644
--- a/docs/index.rst.in
+++ b/docs/index.rst.in
@@ -5,7 +5,7 @@
before the documentation is built.
This file will be copied to the top level and thus please use relative paths
as if this file would be in <TFM_ROOT_DIR>.
-
+
The values between @ characters will be filled in by CMake.
@@ -17,10 +17,10 @@
:glob:
:hidden:
- contributing
+ docs/contributing
docs/dco
- glossary
- maintainers
+ docs/glossary
+ docs/maintainers
docs/user_guides/tfm_sw_requirement
docs/user_guides/tfm_build_instruction
docs/coding_guide
diff --git a/maintainers.rst b/docs/maintainers.rst
similarity index 96%
rename from maintainers.rst
rename to docs/maintainers.rst
index 8a09445..be99af2 100644
--- a/maintainers.rst
+++ b/docs/maintainers.rst
@@ -6,7 +6,7 @@
Sub-maintainers' approval is required for their specific areas of ownership.
Contributions must follow the instructions in
-:doc:`Contributing Guidelines </contributing>`.
+:doc:`Contributing Guidelines </docs/contributing>`.
Maintainers
-----------
diff --git a/docs/processes/tfm_design_proposal_process.rst b/docs/processes/tfm_design_proposal_process.rst
index 478220e..1a8ed88 100644
--- a/docs/processes/tfm_design_proposal_process.rst
+++ b/docs/processes/tfm_design_proposal_process.rst
@@ -95,7 +95,7 @@
!define REJECTED_DIR **docs/design_documents/rejected/**
!define GERRIT_URL https://review.trustedfirmware.org
!define GERRIT_LINK [[GERRIT_URL trustedfirmware.org]]
- !define MAINTAINER_RST_URL https://git.trustedfirmware.org/trusted-firmware-m.git/tree/maintainers.rst
+ !define MAINTAINER_RST_URL https://git.trustedfirmware.org/trusted-firmware-m.git/tree/docs/maintainers.rst
!define TFM_MAILING_LIST mailto:tf-m@lists.trustedfirmware.org
!define NO_DECISION **no**
!define YES_DECISION **yes**
diff --git a/readme.rst b/readme.rst
index f63f9b9..c135b28 100644
--- a/readme.rst
+++ b/readme.rst
@@ -11,7 +11,7 @@
however we expect the code to evolve along with the specifications.
Terms ``TFM`` and ``TF-M`` are commonly used in documents and code and both
-refer to ``Trusted Firmware M.`` :doc:`Glossary </glossary>` has the list
+refer to ``Trusted Firmware M.`` :doc:`Glossary </docs/glossary>` has the list
of terms and abbreviations.
#######
@@ -19,7 +19,7 @@
#######
The software is provided under a BSD-3-Clause :doc:`License </license>`.
Contributions to this project are accepted under the same license with developer
-sign-off as described in the :doc:`Contributing Guidelines </contributing>`.
+sign-off as described in the :doc:`Contributing Guidelines </docs/contributing>`.
This project contains code from other projects as listed below. The code from
external projects is limited to ``app`` and ``platform`` folders.
@@ -137,9 +137,9 @@
To port TF-M to a another system or OS, follow the
:doc:`OS Integration Guide </docs/user_guides/tfm_integration_guide>`
-Please also see the :doc:`glossary </glossary>` of terms used in the project.
+Please also see the :doc:`glossary </docs/glossary>` of terms used in the project.
-:doc:`Contributing Guidelines </contributing>` contains guidance on how to
+:doc:`Contributing Guidelines </docs/contributing>` contains guidance on how to
contribute to this project.
Further documents can be found in the ``docs`` folder.