From 2e6d052ad7d3d538cb4ab44f604aa7a711a7737d Mon Sep 17 00:00:00 2001
From: Gururaj Shetty <gururaj.shetty@huawei.com>
Date: Mon, 25 Oct 2021 12:40:16 +0530
Subject: [PATCH] Project Rename
* Project renamed
* Closes #77
Signed-off-by: Gururaj Shetty <gururaj.shetty@huawei.com>
---
CONTRIBUTING.md | 4 +-
README.md | 20 +++---
building-project-documentation.rst | 2 +-
ci/device-testing.rst | 4 +-
ci/docs.rst | 10 +--
ci/index.rst | 5 +-
ci/{meta-ohos.rst => oniro.rst} | 23 ++++---
ci/xts-acts.rst | 82 ------------------------
community-chat-platform.rst | 14 ++--
conf.py | 2 +-
contributing/gitlab.rst | 4 +-
contributing/reuse.rst | 2 +-
definitions.rst | 4 +-
releases/aladeen/0.1.0/release_notes.rst | 11 +---
14 files changed, 48 insertions(+), 139 deletions(-)
rename ci/{meta-ohos.rst => oniro.rst} (57%)
delete mode 100644 ci/xts-acts.rst
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index afe6809..decda03 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,7 +18,7 @@ SPDX-License-Identifier: CC-BY-4.0
## Overview
-The All Scenarios OS project handles contributions as [merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/) to relevant repositories part of the All Scenarios OS [GitLab instance](https://git.ostc-eu.org/OSTC/OHOS). The flow for handling that is classic: fork-based merge requests. This means that once you have an account, you can fork any repository, create a branch with proposed changes and raise a merge request against the forked repository. More generic information you can find on the Gitlab's documentation as part of ["Merge requests workflow"](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html).
+The Oniro Project handles contributions as [merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/) to relevant repositories part of the Oniro Project [GitLab instance](https://booting.oniroproject.org/distro). The flow for handling that is classic: fork-based merge requests. This means that once you have an account, you can fork any repository, create a branch with proposed changes and raise a merge request against the forked repository. More generic information you can find on the Gitlab's documentation as part of ["Merge requests workflow"](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html).
# REUSE compliance
@@ -52,7 +52,7 @@ Make sure all of your submitted new files have a licensing statement in the head
### Substantial contributions
-Therefore, if your contribution is only a patch directly applied to an existing file, then you are not required to do anything. If your contribution is an entire new project, or a substantial, copyrighted contribution, you **MUST** make sure that you do that following the [IP Policy](https://git.ostc-eu.org/OSTC/OHOS/governance/ip-policy/-/blob/dev/oss/policy/source/sections/section05.rst) and that you comply with REUSE standard to include the licensing information where they are required.
+Therefore, if your contribution is only a patch directly applied to an existing file, then you are not required to do anything. If your contribution is an entire new project, or a substantial, copyrighted contribution, you **MUST** make sure that you do that following the [IP Policy](https://booting.oniroproject.org/distro/governance/ip-policy/-/blob/dev/policy/source/sections/section05.rst) and that you comply with REUSE standard to include the licensing information where they are required.
# DCO sign-off
diff --git a/README.md b/README.md
index 4d5b00a..a70db02 100644
--- a/README.md
+++ b/README.md
@@ -4,27 +4,27 @@ SPDX-FileCopyrightText: Huawei Inc.
SPDX-License-Identifier: CC-BY-4.0
-->
-# All Scenarios OS Documentation Repository
+# Oniro Project Documentation Repository
-[](https://allscenarios.readthedocs.io/en/latest/?badge=latest)
+[](https://docs.oniroproject.org/en/latest/)
-This repository provides the overarching documentation of the All Scenarios OS
-project. It does that by aggregating multiple `sphinx` projects part of
-the All Scenarios OS ecosystem and consolidating all these documentation trees as part of
+This repository provides the overarching documentation of the Oniro
+Project. It does that by aggregating multiple `sphinx` projects part of
+the Oniro Project ecosystem and consolidating all these documentation trees as part of
one, project-wide, `sphinx` project.
## Read The Docs
-As part of the All Scenarios OS infrastructure, this documentation is pushed to a
+As part of the Oniro Project infrastructure, this documentation is pushed to a
Read The Docs project. You can inspect the `latest` version
-[online](https://allscenarios.readthedocs.io/en/latest) or download it as
-[PDF](https://allscenarios.readthedocs.io/_/downloads/en/latest/pdf/).
+[online](https://docs.oniroproject.org/en/latest/) or download it as
+[PDF](https://docs.oniroproject.org/_/downloads/en/latest/pdf/).
## Building the docs
As per the current implementation for satisfying aggregation of multiple
`sphinx` projects, the repository takes advantage of symlinks which assume a
-workspace set up from [the manifest repository](https://git.ostc-eu.org/OSTC/OHOS/manifest/).
+workspace set up from [the oniro repository](https://booting.oniroproject.org/distro/oniro/).
Once that is initialized and synced, one can build/validate the documentation
by simply running:
@@ -32,7 +32,7 @@ by simply running:
make
```
-For the above command to succeed, ensure all the [prerequisites](https://allscenarios.readthedocs.io/en/latest/building-project-documentation.html) are satisfied.
+For the above command to succeed, ensure all the [prerequisites](https://docs.oniroproject.org/en/latest/building-project-documentation.html) are satisfied.
## Contributing
diff --git a/building-project-documentation.rst b/building-project-documentation.rst
index ea0057b..ad16936 100644
--- a/building-project-documentation.rst
+++ b/building-project-documentation.rst
@@ -9,7 +9,7 @@ Building |main_project_name| documentation
This topic outlines the standard way of generating the |main_project_name|
project documentation locally using the source files available in the
-`git.ostc-eu.org <https://git.ostc-eu.org/OSTC/OHOS/docs>`__ repository which
+`booting.oniroproject.org <https://booting.oniroproject.org/distro/docs>`__ repository which
aggregates documentation from multiple other components.
Overview
diff --git a/ci/device-testing.rst b/ci/device-testing.rst
index 32bbb8d..9cef4b1 100644
--- a/ci/device-testing.rst
+++ b/ci/device-testing.rst
@@ -78,7 +78,7 @@ References
* For more details on LAVA, see `Introduction to LAVA <https://docs.lavasoftware.org/lava/>`__.
* For configuring and adding a new device, see `Adding your first devices <https://docs.lavasoftware.org/lava/first-devices.html>`__.
-* For more details on LAVA test job definition template, see `lava-test <https://allscenarios.readthedocs.io/en/latest/repos/manifest/ci/hidden-jobs/lava-test.html>`_.
+* For more details on LAVA test job definition template, see `lava-test <https://docs.oniroproject.org/en/latest/oniro/ci/hidden-jobs/lava-test.html>`_.
* For sample test job definition, see `sample jobs <https://git.lavasoftware.org/lava/lava/-/tree/master/tests/lava_scheduler_app/sample_jobs>`__.
-* For our CI test job definition, see `CI jobs <https://allscenarios.readthedocs.io/en/latest/repos/manifest/ci/hidden-jobs/lava-report.html>`__.
+* For our CI test job definition, see `CI jobs <https://docs.oniroproject.org/en/latest/oniro/ci/hidden-jobs/lava-report.html>`__.
* For LAVA supported device list, see `Supported Devices <https://git.lavasoftware.org/lava/lava/-/tree/master/etc/dispatcher-config/device-types>`__.
diff --git a/ci/docs.rst b/ci/docs.rst
index 3a30c04..a8f3081 100644
--- a/ci/docs.rst
+++ b/ci/docs.rst
@@ -7,14 +7,14 @@
The docs Repository
===================
-.. _docs repository: https://git.ostc-eu.org/OSTC/OHOS/docs.git
+.. _docs repository: https://booting.oniroproject.org/distro/docs.git
The `docs repository`_ contains the general documentation of the |main_project_name|
project. The documentation is normally written in reStructuredText, with an
important difference. Unlike in a regular project, the documentation here is not
standalone. Instead, the git repository contains symbolic links that are valid
-when an entire workspace is constructed with ``git-repo`` and the `manifest
-<https://git.ostc-eu.org/OSTC/OHOS/manifest>`_ repository.
+when an entire workspace is constructed with `oniro
+<https://booting.oniroproject.org/distro/oniro>`_ repository.
This complicates the testing process and the deployment process, but allows the
resulting documentation to span multiple repositories, permitting code and text
@@ -34,13 +34,13 @@ deploy
......
The ``deploy`` job builds aggregated documentation view that is rendered at
-https://allscenarios.readthedocs.org/. This job effectively constructs the
+https://docs.oniroproject.org/. This job effectively constructs the
workspace as described above and then archives the entire documentation source code,
de-referencing any links that were followed to other repositories, and commits the
updated set of files to helper repository which is observed by readthedocs.
The helper repository is called `allscenarios-readthedocs-aggregated
-<https://git.ostc-eu.org/OSTC/infrastructure/allscenarios-readthedocs-aggregated>`_.
+<https://booting.oniroproject.org/distro/oniro-readthedocs-aggregated>`_.
That repository contains a webhook, configured at the level of the GitLab project, which
asks readthedocs to re-build the documentation.
diff --git a/ci/index.rst b/ci/index.rst
index db28bd0..7d60295 100644
--- a/ci/index.rst
+++ b/ci/index.rst
@@ -7,7 +7,7 @@
Continuous Integration
======================
-|main_project_name| ``git`` repositories hosted on https://git.ostc-eu.org/OSTC use
+|main_project_name| ``git`` repositories hosted on https://booting.oniroproject.org/distro use
GitLab pipelines for building and testing changes before they are merged.
Individual pipelines are documented in each repository, but some general or more
important elements are described below.
@@ -15,7 +15,6 @@ important elements are described below.
.. toctree::
:maxdepth: 1
- meta-ohos
- xts-acts
+ oniro
docs
device-testing
diff --git a/ci/meta-ohos.rst b/ci/oniro.rst
similarity index 57%
rename from ci/meta-ohos.rst
rename to ci/oniro.rst
index 2bf2eb7..641c323 100644
--- a/ci/meta-ohos.rst
+++ b/ci/oniro.rst
@@ -4,28 +4,27 @@
.. include:: ../definitions.rst
-The meta-ohos Repository
-========================
+The oniro Repository
+====================
-.. _meta-ohos repository: https://git.ostc-eu.org/OSTC/OHOS/meta-ohos.git
+.. _oniro repository: https://booting.oniroproject.org/distro/oniro.git
-The `meta-ohos repository`_ contains meta-layers specific to |main_project_name| and is
-the second most important repository after the manifest repository.
+The `oniro repository`_ contains meta-layers specific to |main_project_name| and is
+the most important repository.
The CI pipeline is defined in the file ``.ostc-ci/gitlab-ci.yml``.
Shared Job Definitions
----------------------
-The *meta-ohos* repository does not maintain the list of configurations to
-build. That list is included from the *manifest* repository. In result both
-repositories observe the same set of builds jobs, covering all the supported
+The *oniro* repository maintains the list of configurations to
+build. That list includes all the builds jobs, covering all the supported
configurations.
The pipeline customizes the ``.build`` job to allow the build process to take
-into account any changes being introduced to the `meta-ohos` repository by the
+into account any changes being introduced to the `oniro` repository by the
incoming pull request. This is done by setting the ``OHOS_CI_GIT_REPO_PATH``
-variable, which is used by the ``.workspace`` job defined in the *manifest*
+variable, which is used by the ``.workspace`` job defined in the *oniro*
repository.
Special Jobs
@@ -44,6 +43,6 @@ update-docs
This job runs whenever changes land on the default branch and affect either the
pipeline or the ``docs/`` directory. This job *triggers* the pipeline of the
-``OSTC/OHOS/docs`` repository, ensuring that any change to documentation
-present in *meta-ohos* is reflected in the aggregated documentation build
+``distro/docs`` repository, ensuring that any change to documentation
+present in *oniro* is reflected in the aggregated documentation build
maintained in the *docs* repository.
diff --git a/ci/xts-acts.rst b/ci/xts-acts.rst
deleted file mode 100644
index 66c1fa5..0000000
--- a/ci/xts-acts.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-.. SPDX-FileCopyrightText: Huawei Inc.
-..
-.. SPDX-License-Identifier: CC-BY-4.0
-
-The xts_acts Repository
-=======================
-
-.. _xts_acts repository: https://git.ostc-eu.org/OSTC/OHOS/components/staging/xts_acts.git
-
-The `xts_acts repository`_ contains source code for the OpenHarmony Application
-Compatibility Test Suite. It is relevant to CI because changes proposed here
-result in booting a test image, running ACTS binaries and storing the results
-back into GitLab.
-
-The CI pipeline is defined in the file ``.ostc-ci/gitlab-ci.yml``.
-
-Shared Job Definitions
-----------------------
-
-The *xts_acts* repository does not maintain the list of configurations to
-build. That list is included from the *manifest* repository. In result both
-repositories observe the same set of builds jobs, covering all the supported
-configurations.
-
-The pipeline customizes the ``.build`` job to allow the build process to take
-into account any changes being introduced to the *xts_acts* repository by the
-incoming pull request. This is done by setting ``OHOS_CI_DEVTOOL_RECIPE_NAME``
-and ``OHOS_CI_DEVTOOL_LAYER_PATH`` to effectively use ``devtool`` to upgrade the
-``ohos-xts-acts`` recipe to the source code contained in the proposed change.
-The two variables are used by the ``.workspace`` job defined in the *manifest*
-repository.
-
-The ``.build`` job is further customized to use `wic` to create a bootable
-image. The image is available as an artifact used by a pair of jobs in
-conjunction with ``spread``.
-
-In addition, the pipeline disables all the build jobs with the exception of the
-``linux-qemu-x86_64``. Currently ACTS is only executed on a virtual machine
-operated by ``qemu-system-x86_64``, other builds would only waste resources.
-
-Special Jobs
-------------
-
-This pipeline contains two additional jobs, both related to using ``spread`` to
-boot the built system image and execute ACTS binaries. The jobs are identical
-with the exception of the *spread suite* used.
-
-spread-linux-failing
-....................
-
-This job depends on the ``linux-qemu-x86_64`` job and uses the provided system
-image artifact. The job runs ``spread`` that in turn uses ``qemu-system-x86_64``
-to boot the test image and execute *spread tasks* corresponding to individual
-ACTS programs.
-
-This job runs the *spread suite* ``tests/acts-failing`` and is allowed to fail
-without blocking the pipeline. Tests executed here contain one or more failures
-when working on Linux. Over time, as tests are debugged and ported to Linux,
-they are moved to the ``tests/acts-passing`` test suite.
-
-.. _spread documentation: https://github.com/snapcore/spread
-
-You can refer to upstream `spread documentation`_ for details.
-
-spread-linux-passing
-....................
-
-This job is identical to ``spread-linux-failing`` except that it is not allowed to fail
-and that it runs `tests/acts-passing` spread test suite.
-
-Implementation Highlights
--------------------------
-
-The system image is constructed with ``wic`` and a customized kick-start file. The
-test image uses a fixed user name and password of ``root`` and ``ohos``
-respectively and relies on network connectivity and ssh support to drive the
-test process.
-
-.. _oh-spread fork: https://git.ostc-eu.org/OSTC/tools/oh-spread
-
-The version of *spread* used here is the `oh-spread fork`_, with additional
-patches applied against the upstream version.
diff --git a/community-chat-platform.rst b/community-chat-platform.rst
index 68b0e3a..d962193 100644
--- a/community-chat-platform.rst
+++ b/community-chat-platform.rst
@@ -14,30 +14,30 @@ Overview
********
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 |main_project_name| Mattermost instance <https://chat.booting.oniroproject.org>`_ is used
as the primary communication tool by project members, contributors, and the
community.
Authentication
**************
-To access the `OSTC Mattermost instance <https://chat.ostc-eu.org>`_, one will
+To access the `|main_project_name| Mattermost instance <https://chat.booting.oniroproject.org>`_, one will
need an account on the project's GitLab instance. The chat platform will handle
the authentication through GitLab, redirecting the user accordingly. New
account registration can be handled through this authentication process as well
by using the ``Register now`` link in GitLab.
-* Go to `<https://chat.ostc-eu.org>`
-* Login request will redirect you to `<https://git.ostc-eu.org>`
+* Go to `<https://chat.booting.oniroproject.org>`
+* Login request will redirect you to `<https://booting.oniroproject.org>`
* Login using an existing account
* Create a new account following ``Register now`` link
-* The system will redirect you back to `<https://chat.ostc-eu.org>`
+* The system will redirect you back to `<https://chat.booting.oniroproject.org>`
Chat Channels
*************
-The `OSTC Mattermost instance <https://chat.ostc-eu.org>`_ is organised in
-channels. The main one is the `Town Square <https://chat.ostc-eu.org/ostc/channels/town-square>`_
+The `|main_project_name| Mattermost instance <https://chat.booting.oniroproject.org>`_ is organised in
+channels. The main one is the `Town Square <https://chat.booting.oniroproject.org/ostc/channels/town-square>`_
and provides a default place for communication.
To join/explore other a public channel, do the following:
diff --git a/conf.py b/conf.py
index b2c2acf..3a3bb14 100644
--- a/conf.py
+++ b/conf.py
@@ -21,7 +21,7 @@
# -- Project information -----------------------------------------------------
-project = 'All Scenarios OS'
+project = 'Oniro Project'
copyright = '2021'
author = 'Oniro Project'
diff --git a/contributing/gitlab.rst b/contributing/gitlab.rst
index 1436b86..6adb468 100644
--- a/contributing/gitlab.rst
+++ b/contributing/gitlab.rst
@@ -14,7 +14,7 @@ Overview
********
|main_project_name| project handles contributions as `merge requests <https://docs.gitlab.com/ee/user/project/merge_requests/>`_
-to relevant repositories part of the |main_project_name| `GitLab instance <https://git.ostc-eu.org/OSTC/OHOS>`_.
+to relevant repositories part of the |main_project_name| `GitLab instance <https://booting.oniroproject.org/distro/oniro>`_.
The flow for handling that is classic: fork-based merge requests. This means
that once you have an account, you can fork any repository, create a branch
with proposed changes and raise a merge request against the forked repository.
@@ -134,7 +134,7 @@ to remain the same. The only difference is that documentation files are to be
released under ``Creative Commons License version 4.0``.
Documentation that doesn't link directly to one specific repository, is
-available in the `docs repository <https://git.ostc-eu.org/OSTC/OHOS/docs>`_.
+available in the `docs repository <https://booting.oniroproject.org/distro/docs>`_.
In terms of file format, the project unifies its documentation as
``ReStructuredText`` files. A RestructuredText primer is available as part of
diff --git a/contributing/reuse.rst b/contributing/reuse.rst
index 148b9cc..6546d58 100644
--- a/contributing/reuse.rst
+++ b/contributing/reuse.rst
@@ -45,4 +45,4 @@ Make sure all of your submitted new files have a licensing statement in the head
Substantial contributions
-------------------------
-Therefore, if your contribution is only a patch directly applied to an existing file, then you are not required to do anything. If your contribution is an entire new project, or a substantial, copyrighted contribution, you **MUST** make sure that you do that following the `IP Policy <https://git.ostc-eu.org/OSTC/OHOS/governance/ip-policy>`_ and that you comply with REUSE standard to include the licensing information where they are required.
+Therefore, if your contribution is only a patch directly applied to an existing file, then you are not required to do anything. If your contribution is an entire new project, or a substantial, copyrighted contribution, you **MUST** make sure that you do that following the `IP Policy <https://booting.oniroproject.org/distro/governance/ip-policy>`_ and that you comply with REUSE standard to include the licensing information where they are required.
diff --git a/definitions.rst b/definitions.rst
index 2279d95..32064ed 100644
--- a/definitions.rst
+++ b/definitions.rst
@@ -1,8 +1,8 @@
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
-.. |main_project_name| replace:: All Scenarios OS
+.. |main_project_name| replace:: Oniro Project
.. |contact_info| replace:: <TBD>
.. |security_contact| replace:: <TBD>
.. |security_public_key| replace:: <TBD>
-.. |security_bugtracker| replace:: <https://git.ostc-eu.org/security-team/security-bugs/-/issues>
+.. |security_bugtracker| replace:: <https://booting.oniroproject.org/security/bugtracker/-/issues>
diff --git a/releases/aladeen/0.1.0/release_notes.rst b/releases/aladeen/0.1.0/release_notes.rst
index 63a97c6..63e91ab 100644
--- a/releases/aladeen/0.1.0/release_notes.rst
+++ b/releases/aladeen/0.1.0/release_notes.rst
@@ -111,7 +111,7 @@ while using the release tag for the repo init commands as follows:
.. code-block:: console
- repo init -u https://git.ostc-eu.org/OSTC/OHOS/manifest.git -b refs/tags/v0.1.0
+ repo init -u https://booting.oniroproject.org/distro/oniro.git -b refs/tags/v0.1.0
Known issues
------------
@@ -125,7 +125,7 @@ Source code available
For more details on our repo structure, see:
-`OSTC group at GitLab <https://git.ostc-eu.org/OSTC>`__ document
+`|main_project_name| group at GitLab <https://booting.oniroproject.org/distro>`__ document
Devops infrastructure
*********************
@@ -134,13 +134,6 @@ To learn more about our approach to CI (Continuous Integration) strategy used fo
:doc:`/ci/index` document
-Testing
--------
-
-For more details please refer to:
-
-:doc:`/ci/xts-acts` document
-
Contributions
*************
--
GitLab