Skip to content
Snippets Groups Projects
Commit 9a0f354f authored by Gururaj Shetty's avatar Gururaj Shetty
Browse files

Use definitions for project name


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

Signed-off-by: default avatarGururaj Shetty <gururaj.shetty@huawei.com>
parent 22bd420f
No related branches found
No related tags found
No related merge requests found
...@@ -2,13 +2,15 @@ ...@@ -2,13 +2,15 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
On-device Testing On-device Testing
================= =================
Overview Overview
-------- --------
All Scenarios OS implements distributed device testing using Linaro Automation |main_project_name| implements distributed device testing using Linaro Automation
and Validation Architecture (LAVA). This architecture creates an environment and Validation Architecture (LAVA). This architecture creates an environment
where you can operate the necessary physical infrastructure responsible for where you can operate the necessary physical infrastructure responsible for
testing development on real devices, like operating system boot-loader and testing development on real devices, like operating system boot-loader and
......
...@@ -2,12 +2,14 @@ ...@@ -2,12 +2,14 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
The docs Repository The docs Repository
=================== ===================
.. _docs repository: https://git.ostc-eu.org/OSTC/OHOS/docs.git .. _docs repository: https://git.ostc-eu.org/OSTC/OHOS/docs.git
The `docs repository`_ contains the general documentation of the All Scenarios OS The `docs repository`_ contains the general documentation of the |main_project_name|
project. The documentation is normally written in reStructuredText, with an project. The documentation is normally written in reStructuredText, with an
important difference. Unlike in a regular project, the documentation here is not important difference. Unlike in a regular project, the documentation here is not
standalone. Instead, the git repository contains symbolic links that are valid standalone. Instead, the git repository contains symbolic links that are valid
......
...@@ -2,10 +2,12 @@ ...@@ -2,10 +2,12 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
Continuous Integration Continuous Integration
====================== ======================
All Scenarios OS ``git`` repositories hosted on https://git.ostc-eu.org/OSTC use |main_project_name| ``git`` repositories hosted on https://git.ostc-eu.org/OSTC use
GitLab pipelines for building and testing changes before they are merged. GitLab pipelines for building and testing changes before they are merged.
Individual pipelines are documented in each repository, but some general or more Individual pipelines are documented in each repository, but some general or more
important elements are described below. important elements are described below.
......
...@@ -2,12 +2,14 @@ ...@@ -2,12 +2,14 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
The meta-ohos Repository The meta-ohos Repository
======================== ========================
.. _meta-ohos repository: https://git.ostc-eu.org/OSTC/OHOS/meta-ohos.git .. _meta-ohos repository: https://git.ostc-eu.org/OSTC/OHOS/meta-ohos.git
The `meta-ohos repository`_ contains meta-layers specific to All Scenarios OS and is The `meta-ohos repository`_ contains meta-layers specific to |main_project_name| and is
the second most important repository after the manifest repository. the second most important repository after the manifest repository.
The CI pipeline is defined in the file ``.ostc-ci/gitlab-ci.yml``. The CI pipeline is defined in the file ``.ostc-ci/gitlab-ci.yml``.
......
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
.. include:: definitions.rst
Community Chat Platform Community Chat Platform
####################### #######################
...@@ -11,7 +13,7 @@ Community Chat Platform ...@@ -11,7 +13,7 @@ Community Chat Platform
Overview Overview
******** ********
The All Scenarios OS project has a friendly community providing an open platform for The |main_project_name| project has a friendly community providing an open platform for
discussions. `The OSTC Mattermost instance <https://chat.ostc-eu.org>`_ is used discussions. `The OSTC Mattermost instance <https://chat.ostc-eu.org>`_ is used
as the primary communication tool by project members, contributors, and the as the primary communication tool by project members, contributors, and the
community. community.
......
...@@ -29,7 +29,7 @@ Commit Guidelines ...@@ -29,7 +29,7 @@ Commit Guidelines
If you are new to ``git``, start by reading the official If you are new to ``git``, start by reading the official
`Getting Started Document <https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup>`_. `Getting Started Document <https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup>`_.
At its core, contributing to the All Scenarios OS project means *wrapping* your work as ``git`` At its core, contributing to the |main_project_name| project means *wrapping* your work as ``git``
commits. How we handle this has an impact on rebasing, cherry-picking, commits. How we handle this has an impact on rebasing, cherry-picking,
back-porting, and ultimately exposing consistent documentation through its back-porting, and ultimately exposing consistent documentation through its
logs. logs.
......
...@@ -4,8 +4,8 @@ ...@@ -4,8 +4,8 @@
.. include:: ../definitions.rst .. include:: ../definitions.rst
All Scenarios OS vision and aims |main_project_name| vision and aims
================================ ===================================
System Positioning System Positioning
------------------ ------------------
......
...@@ -2,10 +2,12 @@ ...@@ -2,10 +2,12 @@
.. ..
.. SPDX-License-Identifier: CC-BY-4.0 .. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
Git Repositories Git Repositories
================ ================
All Scenarios OS development is organized through a set of ``git`` repositories. |main_project_name| development is organized through a set of ``git`` repositories.
Some of those are documented below. Some of those are documented below.
.. toctree:: .. toctree::
......
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