From 4388d0c6bbc008e38ccc00415e836a99e22121e5 Mon Sep 17 00:00:00 2001
From: ARUL DEVARAJAN <arulkumaran.devarajan@huawei.com>
Date: Thu, 4 Mar 2021 08:35:57 +0000
Subject: [PATCH] Documentation Repository: Project name Placeholder updation
* Project name placeholder is replaced at all occurrences
* Signed-off by Arulkumaran <arulkumaran.devarajan@huawei.com>
---
README.rst | 38 +++++++++++---------
readme/Code of Conduct.rst | 4 +--
readme/Communication in Community.rst | 2 +-
readme/Contributing to the Code.rst | 2 +-
readme/Contributing to the Documentation.rst | 4 +--
readme/Contribution Process.rst | 2 +-
supported-boards/96b-nitrogen.rst | 2 +-
7 files changed, 30 insertions(+), 24 deletions(-)
diff --git a/README.rst b/README.rst
index a98868f..2c31c33 100644
--- a/README.rst
+++ b/README.rst
@@ -1,18 +1,21 @@
-Welcome to OpenHarmony
-######################
-OpenHarmony is an open-source operating system project launched by Huawei with the aim of developing a pool of devices that can communicate and co-operate together irrespective of their make and model.
-OpenHarmony is bridging to a new IoT frontier where any devices you can imagine as connected together, you can imagine to do it transcending the traditional relation between devices and operating system. A revolutionary concept coming to life, thanks to a distributed architecture design based on a set of system capabilities. OpenHarmony OS is able to understand which features and capabilities will improve the UX and propose the best solution for a seamless user experience. It will run on a wide range of user devices that accompany your daily life from health, to fitness, to home appliances, and much more.
+.. include:: ../definitions.rst
-Why OpenHarmony?
-****************
-OpenHarmony is a device-independent platform. The initial version supports devices with 128 KB to 128 MB of memory and the subsequent versions will support higher memory and advanced devices. For device developers, OpenHarmony utilizes a component-based design to tailor its features to better suit specific devices, based on each device's capabilities and service characteristics. OpenHarmony can run on devices with limited resources and wearables with hundreds of KB of memory, as well as more powerful devices, such as smart home cameras and dashcams with hundreds of MB of memory.
+Welcome to |main_project_name|
+##############################
-OpenHarmony Documentation
-*************************
+|main_project_name| is an open-source operating system project launched by Huawei with the aim of developing a pool of devices that can communicate and co-operate together irrespective of their make and model.
+|main_project_name| is bridging to a new IoT frontier where any devices you can imagine as connected together, you can imagine to do it transcending the traditional relation between devices and operating system. A revolutionary concept coming to life, thanks to a distributed architecture design based on a set of system capabilities. |main_project_name| OS is able to understand which features and capabilities will improve the UX and propose the best solution for a seamless user experience. It will run on a wide range of user devices that accompany your daily life from health, to fitness, to home appliances, and much more.
+
+Why |main_project_name|?
+************************
+|main_project_name| is a device-independent platform. The initial version supports devices with 128 KB to 128 MB of memory and the subsequent versions will support higher memory and advanced devices. For device developers, |main_project_name| utilizes a component-based design to tailor its features to better suit specific devices, based on each device's capabilities and service characteristics. |main_project_name| can run on devices with limited resources and wearables with hundreds of KB of memory, as well as more powerful devices, such as smart home cameras and dashcams with hundreds of MB of memory.
+
+|main_project_name| Documentation
+*********************************
* `Getting Started <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/quick-start/build-open-harmony.rst>`_
* `Supported Boards <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/supported-boards/README.rst>`_
-For the latest OpenHarmony Documentation, `Click <https://openharmony-documentation.readthedocs.io>`_.
+For the latest |main_project_name| Documentation, `Click <https://openharmony-documentation.readthedocs.io>`_.
Get Source Code and Tools
*************************
@@ -24,12 +27,15 @@ The first thing to do is to get the required tools and source code for the devel
Contribution Guidelines
***********************
-We welcome you to join the project OpenHarmony and support us in building an Open Source Community and encourages everyone in the community to submit the patches directly to the project. Based on your interest and expertise, you can contribute to the code or/and documentation.
+We welcome you to join the project |main_project_name| and support us in building an Open Source Community and encourages everyone in the community to submit the patches directly to the project. Based on your interest and expertise, you can contribute to the code or/and documentation.
+
+* To know the contribution workflow on how to download code and contribute your code back to the repository, refer `Contribution Process <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Contribution%20Process.rst>`_.
+
+* To contribute to documentation, refer `Contributing to the Documentation <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Contributing%20to%20the%20Documentation.rst>`_.
+
+* All our documents are written in reStructuredText for easy of writing and processing to different format. You can use ReadTheDoc to publish our documents into anyformat you want, or locally generate the required format output using the Sphinx document generator. For more details, refer `Documentation using Sphinx <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/readme/reStructuredText%20Basics.rst>`_
-* To know the contribution workflow on how to download code and contribute your code back to the repository, please refere `Contribution Process <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Contribution%20Process.rst>`_.
-* To contribute to documentation, please refere `Contributing to the Documentation <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Contributing%20to%20the%20Documentation.rst>`_.
-* All our documents are written in reStructuredText for easy of writing and processing to different format. You can use ReadTheDoc to publish our documents into anyformat you want, or locally generate the required format output using the Sphinx document generator. For more details, please refere `Documentation using Sphinx <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/readme/reStructuredText%20Basics.rst>`_
-* In order to maintain consistency across code base, please refere to the `coding style guide <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Contributing%20to%20the%20Code.rst>`_ before you stat contributing to the code base of OpenHarmony.
+* In order to maintain consistency across code base, refer to the `coding style guide <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Contributing%20to%20the%20Code.rst>`_ before you stat contributing to the code base of |main_project_name|.
Where to Turn for Help
**********************
@@ -37,7 +43,7 @@ You can subscribe to the mailing list to get constant updates on new features, r
Code of Conduct
***************
-OpenHarmony is committed to provide a welcoming and inspiring community for all. In order to maintain a collaborative environment, we recommend you to read and follow the community `Code of Conduct <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Code%20of%20Conduct.rst>`_.
+|main_project_name| is committed to provide a welcoming and inspiring community for all. In order to maintain a collaborative environment, we recommend you to read and follow the community `Code of Conduct <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Code%20of%20Conduct.rst>`_.
Contributors & Acknowledgements
*******************************
diff --git a/readme/Code of Conduct.rst b/readme/Code of Conduct.rst
index d5802c9..78a2786 100644
--- a/readme/Code of Conduct.rst
+++ b/readme/Code of Conduct.rst
@@ -3,9 +3,9 @@
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/
+The |main_project_name| 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_info|.
+To report insults, harassment, or other unacceptable behavior, you can contact the |main_project_name| technical committee at |contact_info|.
Our Pledge
**********
diff --git a/readme/Communication in Community.rst b/readme/Communication in Community.rst
index f9c55fd..a790b05 100644
--- a/readme/Communication in Community.rst
+++ b/readme/Communication in Community.rst
@@ -3,7 +3,7 @@
Communication in Community
##########################
-If you encounter any problems when using OpenHarmony, please join the email group for discussion.
+If you encounter any problems when using |main_project_name|, please join the email group for discussion.
How Do I Subscribe to a Mail List?
**********************************
diff --git a/readme/Contributing to the Code.rst b/readme/Contributing to the Code.rst
index b3a0e7d..f21ecc5 100644
--- a/readme/Contributing to the Code.rst
+++ b/readme/Contributing to the Code.rst
@@ -8,7 +8,7 @@ Start Contributions
Code Style
==========
-Develop, review, and test code following the OpenHarmony coding standards. Make sure code is written in the same style.
+Develop, review, and test code following the |main_project_name| coding standards. Make sure code is written in the same style.
* `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>`_
diff --git a/readme/Contributing to the Documentation.rst b/readme/Contributing to the Documentation.rst
index 7f24cd2..79c8fb1 100644
--- a/readme/Contributing to the Documentation.rst
+++ b/readme/Contributing to the Documentation.rst
@@ -14,7 +14,7 @@ Content Copyright
*****************
The content and pictures submitted by users must be original content and must not infringe others' intellectual property rights.
-OpenHarmony has the right to modify the content that is adopted according to the community regulations and specifications.
+|main_project_name| has the right to modify the content that is adopted according to the community regulations and specifications.
License
*******
@@ -35,7 +35,7 @@ You can perform the following steps to modify a document or supplement some cont
#. Enter your comments and supplementary information in the **Extended Information** text box and click **Submit**.
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.
+ 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>`_.
diff --git a/readme/Contribution Process.rst b/readme/Contribution Process.rst
index fa1272b..f301bf0 100644
--- a/readme/Contribution Process.rst
+++ b/readme/Contribution Process.rst
@@ -10,7 +10,7 @@ Preparations
************
* Install, configure, and use Git. For details, visit https://docs.gitlab.com/runner/install/
* Register an SSH public key. For details, visit https://docs.gitlab.com/ee/ci/ssh_keys/README.html#how-it-works
-* Find the repository that you are interested in on the code hosting platform of OpenHarmony.
+* Find the repository that you are interested in on the code hosting platform of |main_project_name|.
Downloading Code
****************
diff --git a/supported-boards/96b-nitrogen.rst b/supported-boards/96b-nitrogen.rst
index 99d1dce..16dda69 100644
--- a/supported-boards/96b-nitrogen.rst
+++ b/supported-boards/96b-nitrogen.rst
@@ -39,7 +39,7 @@ Supported image
Building an application
=======================
-Open HarmonyOS Zephyr flavour is based on Zephyr kernel.
+|main_project_name|OS Zephyr flavour is based on Zephyr kernel.
* Source the environment with proper template settings, flavour being zephyr and target machine being 96b-nitrogen:
--
GitLab