From 5f1ed7130b2115dbf9f7daecba0a839d5f454965 Mon Sep 17 00:00:00 2001
From: ARUL DEVARAJAN <arulkumaran.devarajan@huawei.com>
Date: Thu, 11 Mar 2021 05:55:12 +0000
Subject: [PATCH] Update Contributing to the Documentation.rst : Reference
Links updated
* Reference Links are updated
* Signed-off By: Arul Kumaran <arulkumaran.devarajan@huawei.com>
---
readme/Contributing to the Documentation.rst | 20 +++++++++++---------
readme/Contribution Process.rst | 2 ++
readme/reStructuredText Basics.rst | 2 ++
3 files changed, 15 insertions(+), 9 deletions(-)
diff --git a/readme/Contributing to the Documentation.rst b/readme/Contributing to the Documentation.rst
index 79c8fb1..4b15a87 100644
--- a/readme/Contributing to the Documentation.rst
+++ b/readme/Contributing to the Documentation.rst
@@ -1,3 +1,5 @@
+.. _document-contribution:
+
.. include:: ../definitions.rst
Documentation Contribution
@@ -7,10 +9,10 @@ You are welcome to make contributions to documentation. You can offer your feedb
Excellent contributors will be awarded and the contributions will be publicized in the developer community.
-* `Contribution-method`_
-* `reStructuredText Basics <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/reStructuredText%20Basics.rst>`_
+* :ref:`contribution-method`
+* :ref:`reStructuredText Basics <restructured-text>`
-Content Copyright
+Content copyright
*****************
The content and pictures submitted by users must be original content and must not infringe others' intellectual property rights.
@@ -20,12 +22,12 @@ License
*******
`Creative Commons License version 4.0 <https://creativecommons.org/licenses/by/4.0/legalcode>`_
-.. _Contribution-method:
+.. _contribution-method:
-Contribution Method
+Contribution method
*******************
-Simple Modification
+Simple modification
===================
You can perform the following steps to modify a document or supplement some content:
@@ -37,9 +39,9 @@ You can perform the following steps to modify a document or supplement some cont
The document team will review your modifications and update the file content accordingly.
You will be appreciated for your support and contributions for the |main_project_name| documentation.
-For more information, see `Contribution Process <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contribution%20Process.rst>`_.
+For more information on contributing to |main_project_name|, see :ref:`Contribution Process <contribution-process>`.
-Feedback on Documentation
+Feedback on documentation
=========================
High-quality feedback helps us continuously improve the documents. The more detailed information you provide, the more helpful it is for us to solve problems.
@@ -56,7 +58,7 @@ Click **New** to submit the issue. The document team will confirm the issue.
* If an issue is associated with another issue or a pull request, you can use its full URL or PR number with the number sign (#) to
reference it.
-Content Creation
+Content creation
================
You are encouraged to summarize experience and create technical content during learning and development to help more developers quickly get started. Tutorials and FAQs are recommended. The following templates are for reference:
diff --git a/readme/Contribution Process.rst b/readme/Contribution Process.rst
index 01b1baa..5165e26 100644
--- a/readme/Contribution Process.rst
+++ b/readme/Contribution Process.rst
@@ -1,3 +1,5 @@
+.. _contribution-process:
+
.. include:: ../definitions.rst
Contribution Process
diff --git a/readme/reStructuredText Basics.rst b/readme/reStructuredText Basics.rst
index 28ad252..d9cbef2 100644
--- a/readme/reStructuredText Basics.rst
+++ b/readme/reStructuredText Basics.rst
@@ -1,3 +1,5 @@
+.. _restructured-text:
+
.. include:: ../definitions.rst
Documentation using Sphinx
--
GitLab