Skip to content
Snippets Groups Projects
Commit 5f1ed713 authored by ARUL DEVARAJAN's avatar ARUL DEVARAJAN Committed by Gururaj Shetty
Browse files

Update Contributing to the Documentation.rst : Reference Links updated

* Reference Links are updated
* Signed-off By: Arul Kumaran <arulkumaran.devarajan@huawei.com>
parent 4c22a394
No related branches found
No related tags found
No related merge requests found
.. _document-contribution:
.. include:: ../definitions.rst .. include:: ../definitions.rst
Documentation Contribution Documentation Contribution
...@@ -7,10 +9,10 @@ You are welcome to make contributions to documentation. You can offer your feedb ...@@ -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. Excellent contributors will be awarded and the contributions will be publicized in the developer community.
* `Contribution-method`_ * :ref:`contribution-method`
* `reStructuredText Basics <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/reStructuredText%20Basics.rst>`_ * :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. The content and pictures submitted by users must be original content and must not infringe others' intellectual property rights.
...@@ -20,12 +22,12 @@ License ...@@ -20,12 +22,12 @@ License
******* *******
`Creative Commons License version 4.0 <https://creativecommons.org/licenses/by/4.0/legalcode>`_ `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: 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 ...@@ -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. 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. 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. 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. ...@@ -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 * 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. 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: 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:
......
.. _contribution-process:
.. include:: ../definitions.rst .. include:: ../definitions.rst
Contribution Process Contribution Process
......
.. _restructured-text:
.. include:: ../definitions.rst .. include:: ../definitions.rst
Documentation using Sphinx Documentation using Sphinx
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment