merging

documentation/source/readme/C Coding Style Guide.rst

@@ -13,7 +13,7 @@ to this guide, you are expected to have the following basic capabilities
 for C rather than being a beginner who wants to learn about C.
 
 #. Understand the ISO standard of C.
-#.  Be familiar with the basic features of C.
+#. Be familiar with the basic features of C.
 #. Understand the standard library of C.
 
 General Principles
@@ -88,12 +88,10 @@ Rule 1.1 Name identifiers in camel case style.
 | value, goto tag                   | underscores (_)                   |
 +-----------------------------------+-----------------------------------+
 
-| Note:
-| The ``constant`` in the above table refers to the variable of the
-  basic data type, enumeration, and string type of the const modifier
-  under the global scope, excluding array, struct and union.
-| The ``variable`` in the above table refers to variables other than the
-  constant definition, all using lowercase.
+.. note:: 
+
+   * The ``constant`` in the above table refers to the variable of the basic data type, enumeration, and string type of the const modifier under the global scope, excluding array, struct and union.
+   * The ``variable`` in the above table refers to variables other than the constant definition, all using lowercase.
 
 Rec 1.1 The larger the scope, the more accurate the name should be.
 -------------------------------------------------------------------

documentation/source/readme/Code of Conduct.rst

 Code of Conduct
 ###############
 
-The OpenHarmony community complies with the code of conduct specified in Contributor Covenant of the open source community. For details, see `Contributor Covenant <https://www.contributor-covenant.org/version/1/4/code-of-conduct/>`_.
+The OpenHarmony community complies with the code of conduct specified in `Contributor Covenant <https://www.contributor-covenant.org/>`_. of the open source community. For details, see https://www.contributor-covenant.org/version/1/4/code-of-conduct/
 
 To report insults, harassment, or other unacceptable behavior, you can contact the OpenHarmony technical committee at contact@openharmony.io.
 

documentation/source/readme/Contributing to the Code.rst

@@ -10,8 +10,9 @@ Develop, review, and test code following the OpenHarmony coding standards. Make
 
 * `C++ Coding Style Guide <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/C++%20Coding%20Style%20Guide.rst>`_
 * `C Coding Style Guide <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/C%20Coding%20Style%20Guide.rst>`_
-* JavaScript Coding Style Guide
-* Python Coding Style Guide
+* `JavaScript Coding Style Guide <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/JavaScript%20Coding%20Style%20Guide.rst>`_
+* `Python Coding Style Guide <https://pep8.org/>`_
+
 
 Contribution Workflow
 *********************

documentation/source/readme/Contributing to the Documentation.rst

@@ -5,8 +5,8 @@ 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.
 
-* :ref:`Contribution-method`
-* `Writing Instructions <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/Documentation/source/Readme/Writing%20Instructions.rst/>`_
+* `Contribution-method`_
+* `reStructuredText Basics <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/reStructuredText%20Basics.rst>`_
 
 Content Copyright
 *****************
@@ -16,7 +16,7 @@ OpenHarmony has the right to modify the content that is adopted according to the
 
 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:
 
@@ -27,7 +27,7 @@ Simple Modification
 ===================
 You can perform the following steps to modify a document or supplement some content:
 
-#. In the upper right corner of the document page, click **Edit** to go to the source file page in the Gitee project.
+#. In the upper right corner of the document page, click **Edit** to go to the source file page in the Gitlab project.
 #. On the page of the source file in **.rst** format, click **Edit** to modify or supplement the file.
 #. After the modification, click **Preview** to confirm the modification result.
 #. Enter your comments and supplementary information in the **Extended Information** text box and click **Submit**.
@@ -35,16 +35,16 @@ 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 OpenHarmony 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, see `Contribution Process <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contribution%20Process.rst>`_.
 
 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.
 
-On the Gitee page, click the **Issue** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details.
+On the Gitlab page, click the **Issue** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details.
 Click **New** to submit the issue. The document team will confirm the issue.
 
-.. note::
+.. note:: 
    * Provide a clear description of the issue, including the missing, outdated, incorrect, or to-be-improved content.
    * Explain the impact of this issue on users.
    * Limit the scope of the given issue to a specific task. If many fields are involved, break the issue down into smaller ones. 

documentation/source/readme/Contribution Process.rst

@@ -44,25 +44,10 @@ Perform the following steps to download the code in the repository to your compu
 
     ``git clone $remote_link``
 
-Using the repo Tool to Download Code Repositories in Batches
-============================================================
-#. Download the repo tool. For details, see `Gitlab Support <https://docs.gitlab.com/ee/user/project/repository/#download-source-code>`_.
 
-   ``curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > /usr/local/bin/repo``
-
-   ``chmod a+x /usr/local/bin/repo``
-
-   ``pip install -i https://pypi.tuna.tsinghua.edu.cn/simple requests``
-
-#. Download code repositories. (There is no **repo branch** parameter.)
-
-   ``repo init -u https://gitee.com/openharmony/manifest.git -b master``
-
-   ``repo sync -c``
-
-   
 Committing Code
 ***************
+
 Committing a Repository (git clone)
 ===================================
 
@@ -105,11 +90,11 @@ Committing Multiple Repositories (repo init/sync)
 
    ``repo config --global repo.token {TOKEN}``
 
-   The token is generated by choosing **Settings > Security Settings > Private Token** on Gitee. Example:
+   The token is generated by choosing **Settings > Security Settings > Private Token** on Gitlab. Example:
 
    ``repo config --global repo.token 211XXXXXXXXXXXXXXXXXXXXXXXX``
 
-#. Create an issue under any repository to be modified on Gitee, and record the issue number (for example, #I1TVV4 in the following figure). (The issue provides a function similar to changeID of Gerrit and is used to associate multiple repositories to be modified. Skip this step if modification of multiple repositories is not involved.)
+#. Create an issue under any repository to be modified on Gitlab, and record the issue number (for example, #I1TVV4 in the following figure). (The issue provides a function similar to changeID of Gerrit and is used to associate multiple repositories to be modified. Skip this step if modification of multiple repositories is not involved.)
 
 #. Create a branch in the local code workspace, modify the code, and commit the changes.
 
@@ -156,13 +141,13 @@ Committing Multiple Repositories (repo init/sync)
 
 Creating a Pull Request
 ***********************
-Access the fork repository on Gitee, click the button for creating a PR, and select the myfeature branch to generate a PR. (Skip this step if a PR has been automatically created using the repo tool.)
+Access the fork repository on Gitlab, click the button for creating a PR, and select the myfeature branch to generate a PR. (Skip this step if a PR has been automatically created using the repo tool.)
 
 For details, visit https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/#how-it-works
 
 .. note::
 
-How do I create PRs at the same time if multiple code repositories have compilation dependencies? During the development of the operating system (OS), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitee uses issues as the dependency identifiers for code repositories with compilation dependencies to commit the PRs. 
+How do I create PRs at the same time if multiple code repositories have compilation dependencies? During the development of the operating system (OS), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitlab uses issues as the dependency identifiers for code repositories with compilation dependencies to commit the PRs. 
 
 Follow the operations below:
 

documentation/source/readme/FAQs.rst

@@ -4,7 +4,7 @@ FAQs
 How Do I Create PRs at the Same Time If Multiple Code Repositories Have Compilation Dependencies?
 *************************************************************************************************
 
-During the development of the operating system (OS), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitee uses issues as the association identifiers for code repositories with dependency dependencies to commit the PRs. Follow the operations below:
+During the development of the operating system (OS), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitlab uses issues as the association identifiers for code repositories with dependency dependencies to commit the PRs. Follow the operations below:
 
 #. Create an issue in any of the code repositories.
 

documentation/source/readme/reStructuredText Basics.rst

-Writing Instructions
-####################
-
 **What is reStructuredText?**
 =============================
 reStructuredText is an easy to read, what-you-see-is-what-you-get plainttext markup syntax and parser system.In other words reStructuredText is a lightweight markup language that is used in static 
@@ -15,6 +12,95 @@ reStructuredText is a lightweight markup language, so it’s easier to read in p
 find text editors that render reStructuredText with syntax highlighting and live previews, without having to invest in complex tools. Compared to some other lightweight markup languages 
 like MarkDown, reStructuredText contains stronger semantic markup tools. Some writers also prefer reStructuredText because the markup standards are more well-defined compared to MarkDown.
 
+**Project setup**
+=================
+
+1. **Install Python**
+
+* Most Windows users do not have Python installed by default, so we begin with the installation of Python itself. 
+
+* To check if you already have Python installed, if not  open the command prompt (Win-r and type cmd). 
+
+* Once the command prompt is open, type **python --version** and press Enter. 
+
+* To install python use this link `<https://www.python.org/downloads/release/python-390/>`_
+
+
+* If Python is installed, you will see the version of Python printed to the screen. 
+
+.. figure:: /images/python.png
+
+
+2. **Install pip**
+   
+Once Python is installed, check for pip which will be installed by default. Enter **pip --version** in command promt to check if the pip is installed in windows. 
+
+For python version later than 3.0, pip is already installed. Just make sure to upgrade pip using the command **python -m pip install --upgrade pip**.
+
+.. figure:: /images/pip.png
+
+
+3. **Check for sphinx installed**
+
+once the pip is installed check for sphinx , open the command prompt (Win-r and type cmd) enter pip install sphinx. 
+
+.. figure:: /images/pipinstallsphinx.png
+
+
+4. **Adding scripts to the the Envionment variable**
+   
+* Navigate to control panel>system and security>system
+
+* **Click** advanced system settings>advanced>environment variables
+
+* Select path and click **edit**
+
+* Click **new** and add **c:/user/<username>/appdata/local/programs/python/python39/script**
+
+* click **ok**
+
+.. figure:: /images/Environment variable.png
+
+.. figure:: /images/path.png
+
+
+5. **Create the files**
+ 
+* Open command promt then type **sphinx-quickstart**
+
+* Select root path by entering y letter
+
+* enter project name, author name, project release name
+
+* Then select project language by entering y letter
+
+* command will appear like see the command that finished an intial directory structure has been created.
+ 
+* Now go to local file and check for source folder. 
+
+* Inside source folder rst file will be there. 
+ 
+
+.. figure:: /images/quickstart.png
+
+
+5. **How to do authoring**
+
+* Open rst file in note pad++
+
+* Type the content or edit it then save it.
+
+* Now to get the HTML format open command promt and enter make html
+
+* Go to build file in local folder 
+
+* Search for html folder and then check for html file, open it in browser.
+
+* If you want make any chages in the content then edit rst file and save it.
+
+.. figure:: /images/source.png
+
+
 **How to use reStructuredText**
 ===============================
 
@@ -83,21 +169,20 @@ For example, this unordered list:
 
 **Images**
 ==========
-reST supports an image directive, first we need to enter colon (..) then single space and write figure then close it with two colons (::) and give single spacing enter (/) and write images close it with (/)
-then enter image file name along with format. 
+reST supports an image directive, used like so: .. image:: gnu.png
 
 *example*
 
 .. figure:: /images/muti data.png
 
 
-**DIRECTIVES**
+**Directives**
 ==============
 directive is a generic block of explicit markup.While Docutils provides a number of directives, Sphinx provides many more and uses directives as one of the primary extension mechanism.
 
 
-First we need to give  colon (..) then write toctree and close it with colon(:) again. 
-next step enter space 3 times then give colon and enter maxdepth close it with colon (:) again. 
+First we need to give  colon (..) then write toctree and close it with colon again. 
+next step enter space 3 times then give colon and enter maxdepth close it wiht colon again. 
 last step is enter space 3 times again and write reference files 
  
 .. toctree::
@@ -151,7 +236,7 @@ The data may be internal (an integral part of the document) or external (a separ
    crunchy, now would it?"
    "Gannet Ripple", 1.99, "On a stick!"
    
-**ROLES**
+**Roles**
 =========
 
 **Cross-referencing syntax**
@@ -166,41 +251,13 @@ we know that, algebric formula
 
 :math:`a^2 + b^2 + 2ab = (a+b)^2`
 
-**Project setup**
-=================
-
-1. **Install python**
-
-Most Windows users do not have Python installed by default, so we begin with the installation of Python itself. To check if you already have Python installed, open the Command Prompt (Win-r and type cmd). 
-Once the command prompt is open, type **python --version** and press Enter. If Python is installed, you will see the version of Python printed to the screen. 
-
-2. **Install pip**
-   
-Once Python is installed, you can install Sphinx using pip. Enter **pip --version** in commsmand promt to check if the pip is installed in windows. 
-For python version later than 3.0, pip is already installed. Just make sure to upgrade pip using the command **python -m pip install --upgrade pip**.
-
-3. **Adding scripts to the the Envionment variable**
-   
-* Navigate to control panel/system and security/system
+**Reference**
+=============
+`<https://www.sphinx-doc.org/en/master/usage/installation.html>`_
 
-* Click  advanced system settings/advanced/environment variables
+`<https://www.sphinx-doc.org/en/master/contents.html>`_
 
-* Select path and click edit
 
-* Click new and add c:/user/<username>/appdata/local/programs/python/python39/script
 
-* click ok
 
-4. **Create the files**
- 
-* Open command promt then type sphinx-quickstart
 
-* Select root path by entering y letter
-
-* enter project name, author name, project release name
-
-* Then select project language by entering y letter
-
-You see the command that finished an intial directory structure has been created
- 
-Now you can edit the rst files
\ No newline at end of file

readme.rst

@@ -10,7 +10,7 @@ Start Contributing
 ******************
 OpenHarmony is an Open Source Community and encourages everyone in the community to submit the patches directly to the project. You can either contribute to the code or documentation.
 
-* `Contributing to the Code <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/Documentation/source/Readme/Contributing%20to%20the%20Code.rst>`_
+* `Contributing to the Code <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/FAQs.rst>`_
 * `Contributing to the Documentation <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/Documentation/source/Readme/Contributing%20to%20the%20Documentation.rst>`_
 
 For more details on Contribution, see `Contributing to the Documentation <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/Documentation/source/Readme/Contributing%20to%20the%20Documentation.rst>`_.
@@ -29,4 +29,4 @@ A great Open source project wouldn't exist without the hard work of its many con
 
 Release
 *******
-In order to provide new features and bug fixes, the community constantly updates the code and provides new releases.
\ No newline at end of file
+In order to provide new features and bug fixes, the community constantly updates the code and provides new releases.