docs: Use definitions for project name

* All project name replaced with tag
* definitions.rst reference added
* Closes: OSTC/OHOS/docs#77

Signed-off-by: Gururaj Shetty <gururaj.shetty@huawei.com>

docs/allscenarios-quick-build.rst

@@ -2,17 +2,19 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: definitions.rst
+
 .. _AllScenariOSQuickBuild:
 
-All Scenarios OS - Quick Build
-##############################
+|main_project_name| - Quick Build
+#################################
 
-This section will guide you to building your first All Scenarios OS image targeting
+This section will guide you to building your first |main_project_name| image targeting
 a supported reference hardware. It will also provide the steps for flashing and
 booting such an image.
 
 The steps below will focus on a Qemu-based target. If you want to get a feeling
-of All Scenarios OS on a real hardware, checkout the :ref:`Avenger96 support page
+of |main_project_name| on a real hardware, checkout the :ref:`Avenger96 support page
 <SupportedBoardAvenger96>`.
 
 .. contents:: 
@@ -64,7 +66,7 @@ cloned using the repo tool. See above.
 
 .. Note::
 
-   Depending on the configuration type, a single All Scenarios OS build could 
+   Depending on the configuration type, a single |main_project_name| build could 
    use around 100GB of disk space for downloads, temporary files, and build artifacts combined.
 
 Initialize the build directory and run a build:
@@ -74,8 +76,8 @@ Initialize the build directory and run a build:
     $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux
     $ MACHINE=qemux86-64 bitbake allscenarios-image-base
 
-Booting a Qemu X86-64 target with a All Scenarios OS image
-**********************************************************
+Booting a Qemu X86-64 target with a |main_project_name| image
+*************************************************************
 
 Once the image is built, you can run a Qemu X86-64 instance using the provided script wrapper as follows:
 

docs/blueprints/doorlock.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 ##################
 DoorLock Blueprint
 ##################
@@ -132,7 +134,7 @@ The Software
 Get sources
 ===========
 #.
- Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+ Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
 #.
  If you already have sources cloned, update them to the most recent revision
 

docs/blueprints/index.rst

@@ -2,15 +2,17 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
-All Scenarios OS Blueprints
-###########################
+.. include:: ../definitions.rst
+
+|main_project_name| Blueprints
+##############################
 
 Overview
 ********
 
-All Scenarios OS integrates its various components into a representative use-case called a `Blueprint`. A blueprint shows off the OS capabilities and best practices in building software-based products.
+|main_project_name| integrates its various components into a representative use-case called a `Blueprint`. A blueprint shows off the OS capabilities and best practices in building software-based products.
 
-To this end, blueprints are a way to distill real-world products into a ``minimum viable product`` to demonstrate how partners and users may adopt All Scenarios OS securely in their own products.
+To this end, blueprints are a way to distill real-world products into a ``minimum viable product`` to demonstrate how partners and users may adopt |main_project_name| securely in their own products.
 
 What is a Blueprint?
 --------------------
@@ -25,7 +27,7 @@ What is a Blueprint?
       * Display, e.g., showing useful messages on a display.
       * Autonomous communication between two devices over a wireless link.
 
-#. It is implemented on the closest appropriate reference HW platform from All Scenarios OS.
+#. It is implemented on the closest appropriate reference HW platform from |main_project_name|.
 
 What a Blueprint Isn't?
 -----------------------
@@ -36,7 +38,7 @@ What a Blueprint Isn't?
 Blueprints
 **********
 
-This section details the available blueprints provided as part of the All Scenarios OS environment.
+This section details the available blueprints provided as part of the |main_project_name| environment.
 
 .. toctree::
    :maxdepth: 1

docs/blueprints/smart-panel.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 Smart Panel Blueprint
 #####################
 
@@ -134,7 +136,7 @@ IoT devices
 Get sources
 ***********
 #. 
-   Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+   Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
 
 #. 
    If you already have sources cloned, update them to the most recent revision
@@ -333,7 +335,7 @@ Flash
 
 Add Bluetooth firmware
 ----------------------
-Due to licensing details, All Scenarios OS cannot provide the firmware file for
+Due to licensing details, |main_project_name| cannot provide the firmware file for
 the on-board Bluetooth controller. However, user may download and install it
 manually.
 

docs/blueprints/touchpanel.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 TouchPanel Blueprint
 #####################
 
@@ -20,7 +22,7 @@ The TouchPanel Blueprint provides support for building a PoC smart touch panel t
 Get sources
 ***********
 #. 
-   Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+   Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
 
 #. 
    If you already have sources cloned, update them to the most recent revision

docs/blueprints/transparent-gateway.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 Transparent Gateway Blueprint
 #############################
 
@@ -39,7 +41,7 @@ WiFi Access Point Configuration
 
 In our default WiFi access point configuration, we create an AP on channel 6 in the 2.4 GHz band with WPA2 pre-shared key configuration::
 
-   SSID: "All Scenarios OS WiFi"
+   SSID: "|main_project_name| WiFi"
    Passphrase: "12345678".
 
 For more details, the used `hostapd configuration file <https://git.ostc-eu.org/OSTC/OHOS/meta-ohos/-/blob/develop/meta-ohos-blueprints/recipes-connectivity/hostapd/files/hostapd.conf>`_ is the best reference.
@@ -57,7 +59,7 @@ For more details, the used `OpenThread configuration script <https://git.ostc-eu
 Get sources
 ***********
 
-#. Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+#. Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
 #. If you already have sources cloned, update them to the most recent revision.
 
    .. code-block:: bash

docs/blueprints/vending-machine.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 Vending Machine Blueprint
 #########################
 
@@ -12,13 +14,13 @@ Overview
 ********
 
 The Vending Machine Blueprint provides support for building a PoC smart vending machine
-with components showing the capabilities of the All Scenarios OS build infrastructure to easily
+with components showing the capabilities of the |main_project_name| build infrastructure to easily
 build an end-to-end solution using multiple operating systems cooperating inside a product.
 
 Get sources
 ***********
 #. 
-   Get All Scenarios OS sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
+   Get |main_project_name| sources as described in the :ref:`documentation <AllScenariOSQuickBuild>`.
 
 #. 
    If you already have sources cloned, update them to the most recent revision

docs/build-flavours/build-flavours.rst

@@ -2,12 +2,14 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 Overview of Build Flavours
 ##########################
 
-All Scenarios OS can be hosted on top of variety of kernels. Currently supported
+|main_project_name| can be hosted on top of variety of kernels. Currently supported
 kernels are Linux, Zephyr and FreeRTOS (experimental). The build system
-requires build configuration that is specific to each kernel and All Scenarios OS
+requires build configuration that is specific to each kernel and |main_project_name|
 provides all this configuration as build templates. See `Yocto documentation <https://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html#creating-a-custom-template-configuration-directory>`_
 for more info about the underlying mechanism.
 

docs/build-flavours/freertos-flavour.rst

@@ -2,12 +2,14 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 .. _FreeRTOS_Kernel:
 
 FreeRTOS Kernel Build Flavour
 #############################
 
-All Scenarios OS FreeRTOS build flavour is based on *freertos* distribution (distro configuration).
+|main_project_name| FreeRTOS build flavour is based on *freertos* distribution (distro configuration).
 
 Supported images:
 

docs/build-flavours/index.rst

@@ -2,10 +2,12 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
-All Scenarios OS Build Flavours
-###############################
+.. include:: ../definitions.rst
 
-All Scenarios OS provides default build configuration for each supported type of
+|main_project_name| Build Flavours
+##################################
+
+|main_project_name| provides default build configuration for each supported type of
 kernels. Each set of such configuration is called a ``flavour``.
 
 .. toctree::

docs/build-flavours/linux-flavour.rst

@@ -2,12 +2,14 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 .. _Linux_Kernel:
 
 Linux Kernel Build Flavour
 ##########################
 
-All Scenarios OS Linux build flavour is based on *allscenarios-linux* distribution (distro configuration).
+|main_project_name| Linux build flavour is based on *allscenarios-linux* distribution (distro configuration).
 
 Supported images:
 

docs/build-flavours/zephyr-flavour.rst

@@ -2,12 +2,14 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 .. _Zephyr_Kernel:
 
 Zephyr Kernel Build Flavour
 ###########################
 
-All Scenarios OS Zephyr build flavour is based on *allscenarios-zephyr* distribution (distro configuration).
+|main_project_name| Zephyr build flavour is based on *allscenarios-zephyr* distribution (distro configuration).
 
 Supported images:
 

docs/ci/machines-and-flavours.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../definitions.rst
+
 Machines and Flavours
 ---------------------
 
@@ -20,8 +22,8 @@ linux-qemu-x86
 
 This job extends `.build-linux` job from the manifest repository and builds
 ``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=qemux86``. This job checks that
-All Scenarios OS software can be built for a basic 32bit x86 virtual machine.
+the Linux flavour of |main_project_name| and ``MACHINE=qemux86``. This job checks that
+|main_project_name| software can be built for a basic 32bit x86 virtual machine.
 
 The cache for this job is publicly available.
 
@@ -30,8 +32,8 @@ linux-qemu-x86_64
 
 This job extends `.build-linux` job from the manifest repository and builds
 ``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=qemux86-64``. This job checks that
-All Scenarios OS software can be built for a basic 64bit x86 virtual machine.
+the Linux flavour of |main_project_name| and ``MACHINE=qemux86-64``. This job checks that
+|main_project_name| software can be built for a basic 64bit x86 virtual machine.
 
 The cache for this job is publicly available.
 
@@ -40,8 +42,8 @@ linux-seco-intel-b68
 
 This job extends `.build-linux` job from the manifest repository and builds
 ``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=seco-intel-b68``. This job
-checks that All Scenarios OS software can be built for the SECO B68 development
+the Linux flavour of |main_project_name| and ``MACHINE=seco-intel-b68``. This job
+checks that |main_project_name| software can be built for the SECO B68 development
 board, which contains an Intel x86_64 SoC.
 
 .. note::
@@ -53,8 +55,8 @@ linux-seco-imx8mm-c61
 
 This job extends `.build-linux` job from the manifest repository and builds
 ``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=seco-imx8mm-c61``. This job
-checks that All Scenarios OS software can be built for the SECO C61 development
+the Linux flavour of |main_project_name| and ``MACHINE=seco-imx8mm-c61``. This job
+checks that |main_project_name| software can be built for the SECO C61 development
 board, which contains the NXP i.MX 8M Mini SoC, which implements 64bit ARMv8
 architecture.
 
@@ -67,8 +69,8 @@ linux-stm32mp1-av96
 
 This job extends `.build-linux` job from the manifest repository and builds
 ``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=stm32mp1-av96``. This job checks
-that All Scenarios OS software can be built for the 96Boards Avenger development
+the Linux flavour of |main_project_name| and ``MACHINE=stm32mp1-av96``. This job checks
+that |main_project_name| software can be built for the 96Boards Avenger development
 board, which contains the STM32MP157 SoC, which implements 32bit ARMv7
 architecture.
 
@@ -81,8 +83,8 @@ linux-raspberrypi4-64
 
 This job extends `.build-linux` job from the manifest repository and builds
 ``allscenarios-image-base-tests`` and ``allscenarios-image-extra-tests`` using
-the Linux flavour of All Scenarios OS and ``MACHINE=raspberrypi4-64``. This job
-checks that All Scenarios OS software can be built for the Raspberry Pi 4B
+the Linux flavour of |main_project_name| and ``MACHINE=raspberrypi4-64``. This job
+checks that |main_project_name| software can be built for the Raspberry Pi 4B
 development board, which contains the BCM2711 SoC, which implements 64bit ARMv8
 architecture.
 
@@ -94,7 +96,7 @@ zephyr-qemu-x86
 ...............
 
 This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
 ``MACHINE=qemu-x86``. This job checks that Zephyr can be built for a basic
 32bit x86 virtual machine.
 
@@ -104,7 +106,7 @@ zephyr-qemu-cortex-m3
 .....................
 
 This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
 ``MACHINE=qemu-cortex-m3``. This job checks that Zephyr can be built for a
 basic 32bit ARM micro-controller virtual machine.
 
@@ -114,7 +116,7 @@ zephyr-96b-nitrogen
 ...................
 
 This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
 ``MACHINE=96b-nitrogen``. This job checks that Zephyr can be built for the
 96Boards Nitrogen development board, which contains an nRF52832 SoC.
 
@@ -126,7 +128,7 @@ zephyr-96b-avenger
 ..................
 
 This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
 ``MACHINE=96b-avenger96``. This job checks that Zephyr can be built for the
 96Boards Avenger development board cortex-M3 core, embedded into STM32MP157
 SoC.
@@ -139,7 +141,7 @@ zephyr-arduino-nano-33-ble
 ..........................
 
 This job extends `.build-zephyr` job from the manifest repository and builds
-``zephyr-philosophers`` using the Zephyr flavour of All Scenarios OS and
+``zephyr-philosophers`` using the Zephyr flavour of |main_project_name| and
 ``MACHINE=arduino-nano-33-ble``. This job checks that Zephyr can be built for the
 Arduino Nano 33 BLE development board Cortex-M4 core, embedded into nRF 52840
 SoC.
@@ -152,7 +154,7 @@ freertos-armv5
 ..............
 
 This job extends `.build-freertos` job from the manifest repository and builds
-``freertos-demo`` using the FreeRTOS flavour of All Scenarios OS and
+``freertos-demo`` using the FreeRTOS flavour of |main_project_name| and
 ``MACHINE=qemuarmv5``. This job checks that FreeRTOS can be built for a basic
 32bit ARMv5 micro-controller virtual machine.
 

docs/definitions.rst

+.. SPDX-FileCopyrightText: Huawei Inc.
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+.. |main_project_name| replace:: All Scenarios OS

docs/hardware-support/adding-hardware-support.rst

@@ -2,22 +2,24 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
-Adding New Hardware Support in All Scenarios OS
-###############################################
+.. include:: ../definitions.rst
+
+Adding New Hardware Support in |main_project_name|
+##################################################
 
 This section details the addition of new hardware to the supported set in
-All Scenarios OS. It is intended as a checklist for adding new boards to OHOS build
+|main_project_name|. It is intended as a checklist for adding new boards to OHOS build
 system.
 
-Before starting get familiar with All Scenarios OS Contribution Process.
+Before starting get familiar with |main_project_name| Contribution Process.
 
 .. contents:: 
    :depth: 2
 
-Select All Scenarios OS Flavour
-*******************************
+Select |main_project_name| Flavour
+**********************************
 
-All Scenarios OS uses a notion of kernel specific flavours:
+|main_project_name| uses a notion of kernel specific flavours:
 
 - Linux flavour
 - Zephyr flavour
@@ -47,7 +49,7 @@ directory) consist of the following files:
    * - ``local.conf.sample``
      - default flavour build configuration
 
-All Scenarios OS build system uses ***repo*** tool for cloning required meta-layers
+|main_project_name| build system uses ***repo*** tool for cloning required meta-layers
 into appropriate build directory structure (see :ref:`Setting up a repo workspace <RepoWorkspace>`).
 To include a new layer, it has to be added in two places:
 

docs/hardware-support/blueprint-peripherals/index.rst

@@ -2,10 +2,12 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../../definitions.rst
+
 Peripherals used in implementing blueprints
 ###########################################
 
-This section lists some of the peripherals proposed to be used (and supported) as part of All Scenarios OS Blueprints.
+This section lists some of the peripherals proposed to be used (and supported) as part of |main_project_name| Blueprints.
 
 Peripheral Categories
 *********************

docs/hardware-support/blueprint-peripherals/io-devices/index.rst

@@ -2,17 +2,19 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../../../definitions.rst
+
 Input/Output Peripherals used in blueprints
 ###########################################
 
-This section lists some of the peripherals used for input and output used as part of All Scenarios OS Blueprints.
+This section lists some of the peripherals used for input and output used as part of |main_project_name| Blueprints.
 
 .. toctree::
    :maxdepth: 3
 
 Touch-based input
 *****************
-Smart devices accept a variety of input, typically through different types of touch interfaces. Here are a few that are used to produce All Scenarios OS Blueprints.
+Smart devices accept a variety of input, typically through different types of touch interfaces. Here are a few that are used to produce |main_project_name| Blueprints.
 
 Capacitive Touch Sensor
 -----------------------

docs/hardware-support/blueprint-peripherals/lock-devices/index.rst

@@ -2,10 +2,12 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../../../definitions.rst
+
 Lock Peripherals used in blueprints
 ###################################
 
-Smart devices might need keyless locking functionality, e.g., a vending machine, a post box, or a smart door lock. Here are a few that are used in All Scenarios OS Blueprints.
+Smart devices might need keyless locking functionality, e.g., a vending machine, a post box, or a smart door lock. Here are a few that are used in |main_project_name| Blueprints.
 
 .. toctree::
    :maxdepth: 3

docs/hardware-support/boards/96b-nitrogen.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../../definitions.rst
+
 .. _SupportedBoardNitrogen:
 
 96Boards Nitrogen
@@ -38,7 +40,7 @@ Working with the board
 Building an application
 =======================
 
-All Scenarios OS OS 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:
 

docs/hardware-support/boards/arduino-nano-33-ble.rst

@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: ../../definitions.rst
+
 .. _SupportedBoardArduinoNano33BLE:
 
 Arduino Nano 33 BLE
@@ -43,7 +45,7 @@ Working with the board
 Building an application
 =======================
 
-All Scenarios OS Zephyr flavour is based on the Zephyr kernel.
+|main_project_name| Zephyr flavour is based on the Zephyr kernel.
 
 1. Source the environment with proper template settings, the flavour being *zephyr* 
    and target machine being *arduino-nano-33-ble*: