Commit f975eec7 authored by Davide Ricci's avatar Davide Ricci Committed by Stefan Schmidt
Browse files

Brand rename: From OpenHarmony to All Scenarios OS



Highlights of the change:
- Remove OpenHarmony as main brand name.
- Introduce All Scenarios OS as description.
Signed-off-by: Davide Ricci's avatarDavide Ricci <davide.ricci@huawei.com>
parent 40bf9093
......@@ -18,7 +18,7 @@ SPDX-License-Identifier: CC-BY-4.0
## Overview
OpenHarmony project handles contributions as [merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/) to relevant repositories part of the OpenHarmony [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 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).
# REUSE compliance
......
......@@ -4,21 +4,21 @@ SPDX-FileCopyrightText: Huawei Inc.
SPDX-License-Identifier: CC-BY-4.0
-->
# OpenHarmony Documentation Repository
# All Scenarios OS Documentation Repository
[![Documentation Status](https://readthedocs.org/projects/openharmony/badge/?version=latest)](https://openharmony.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/allscenarios/badge/?version=latest)](https://allscenarios.readthedocs.io/en/latest/?badge=latest)
This repository provides the overarching documentation of the OpenHarmony
This repository provides the overarching documentation of the All Scenarios OS
project. It does that by aggregating multiple `sphinx` projects part of
OpenHarmony ecosystem and consolidating all these documentation trees as part of
the All Scenarios OS ecosystem and consolidating all these documentation trees as part of
one, project-wide, `sphinx` project.
## Read The Docs
As part of the OpenHarmony infrastructure, this documentation is pushed to a
As part of the All Scenarios OS infrastructure, this documentation is pushed to a
Read The Docs project. You can inspect the `latest` version
[online](https://openharmony.readthedocs.io/en/latest) or download it as
[PDF](https://openharmony.readthedocs.io/_/downloads/en/latest/pdf/).
[online](https://allscenarios.readthedocs.io/en/latest) or download it as
[PDF](https://allscenarios.readthedocs.io/_/downloads/en/latest/pdf/).
## Building the docs
......
......@@ -7,7 +7,7 @@ The docs Repository
.. _docs repository: https://git.ostc-eu.org/OSTC/OHOS/docs.git
The `docs repository`_ contains the general documentation of the OpenHarmony
The `docs repository`_ contains the general documentation of the All Scenarios OS
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
......@@ -32,13 +32,13 @@ deploy
......
The ``deploy`` job builds aggregated documentation view that is rendered at
https://openharmony.readthedocs.org/. This job effectively constructs the
https://allscenarios.readthedocs.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 `openharmony-readthedocs-aggregated
<https://git.ostc-eu.org/OSTC/infrastructure/openharmony-readthedocs-aggregated>`_.
The helper repository is called `allscenarios-readthedocs-aggregated
<https://git.ostc-eu.org/OSTC/infrastructure/allscenarios-readthedocs-aggregated>`_.
That repository contains a webhook, configured at the level of the GitLab project, which
asks readthedocs to re-build the documentation.
......
......@@ -5,7 +5,7 @@
Continuous Integration
======================
OpenHarmony ``git`` repositories hosted on https://git.ostc-eu.org/OSTC use
All Scenarios OS ``git`` repositories hosted on https://git.ostc-eu.org/OSTC 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.
......
......@@ -7,7 +7,7 @@ The meta-ohos Repository
.. _meta-ohos repository: https://git.ostc-eu.org/OSTC/OHOS/meta-ohos.git
The `meta-ohos repository`_ contains meta-layers specific to OpenHarmony and is
The `meta-ohos repository`_ contains meta-layers specific to All Scenarios OS and is
the second most important repository after the manifest repository.
The CI pipeline is defined in the file ``.ostc-ci/gitlab-ci.yml``.
......
......@@ -11,7 +11,7 @@ Community Chat Platform
Overview
********
OpenHarmony has a friendly community providing an open platform for
The All Scenarios OS project has a friendly community providing an open platform for
discussions. `The OSTC Mattermost instance <https://chat.ostc-eu.org>`_ is used
as the primary communication tool by project members, contributors, and the
community.
......
......@@ -21,7 +21,7 @@
# -- Project information -----------------------------------------------------
project = 'OpenHarmony'
project = 'All Scenarios OS'
copyright = '2021'
author = 'OSTC'
......
......@@ -29,7 +29,7 @@ Commit Guidelines
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>`_.
At its core, contributing to OpenHarmony means *wrapping* your work as ``git``
At its core, contributing to the All Scenarios OS project means *wrapping* your work as ``git``
commits. How we handle this has an impact on rebasing, cherry-picking,
back-porting, and ultimately exposing consistent documentation through its
logs.
......
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
.. |main_project_name| replace:: OpenHarmony
.. |main_project_name| replace:: All Scenarios OS
.. |contact_info| replace:: <TBD>
......@@ -4,7 +4,7 @@
.. include:: ../definitions.rst
OpenHarmony vision and aims
All Scenarios OS vision and aims
===========================
System Positioning
......
......@@ -10,4 +10,4 @@
.. toctree::
:maxdepth: 2
openharmony-vision
allscenarios-vision
......@@ -36,7 +36,7 @@ in September, 2020. This April release serves as a solid foundation upon
which we can share the entire 2021 roadmap of the project.
More details on the |main_project_name| goals can be found in the
:doc:`/overview/openharmony-vision` document.
:doc:`/overview/allscenarios-vision` document.
The list of software features included
--------------------------------------
......@@ -101,7 +101,7 @@ Not available for this release.
Installation
************
:ref:`Quick Build <OpenHarmonyQuickBuild>` provides an example of how to build
:ref:`Quick Build <AllscenariOSQuickBuild>` provides an example of how to build
the |main_project_name| project for a supported target. Visit the
:ref:`Hardware Support <HardwareSupport>` section for instructions on how to
build for other supported targets.
......
......@@ -5,7 +5,7 @@
Git Repositories
================
OpenHarmony development is organized through a set of ``git`` repositories.
All Scenarios OS development is organized through a set of ``git`` repositories.
Some of those are documented below.
.. toctree::
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment