These topic were replaced by a couple of pharagraphs in the
`contributing` section.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Marking TBD in definition.rst for when we'll have a project eclipse
email address.

Signed-off-by: Davide Ricci <davide.ricci@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

This will need to be replaced with actual FAQs in the context of the
project. The generic git related entries right now are of little value.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The IP policy and implementation guidelines are moved from being
standalone root entries to being part of a new section entitled
"Intellectual Property Compliance Policy". This makes the root
documentation level a bit cleaner.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Zygmunt Krynicki authored 3 years ago and Zygmunt Krynicki committed 3 years ago

Brand-new documentation for the four repositories: manifest, meta-ohos,
xts_acts and docs is provided in a format that fits the new documentation
project.

I chose to write it from scratch and avoid the extensive graphics
present in the "ci-docs" repository as I wanted to focus on the essence
first. I plan to follow up with documentation of the REUSE and DCO
check jobs. Separately I would like to explore limited diagrams where
they would convey additional benefits.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Davide Ricci <davide.ricci@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The "about-openharmony" is currently providing the project's aims and
vision. Clarify this by renaming both th file and the section title.

This commit also reformats the text based on line lenght.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The 1.0 release is not yet done so reset the version in preparation for
the next release.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Most of the other sections use `index.rst` as the index file. This does
the same of the overview section..

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Gururaj Shetty authored 3 years ago and Andrei Gherzan committed 3 years ago

This section was imported from gitee and we remove it as it is no longer
relevant to OpenHarmony.

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

The final documentation is flattened from a symlink-based structure.
Pointing from the documentation to the flatten structure will only add
confusion.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

If the pipelines are copied, we will run pipelines not intended for the
flattened repo (SHA will mismatch for example - and generally, it
wouldn't make any sense in another repository context).

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

This is currently only done for the main branch. For every new push to
this branch, the pipeline will push a flatten version of it on the main
branch of openharmony-readthedocs-aggregated referencing the origin
branch and SHA in the commit log.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

That reference is from old docs. The meta-ohos ones don't provide this
reference as of now.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: shettygururaj <gururaj.shetty@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: shettygururaj <gururaj.shetty@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: shettygururaj <gururaj.shetty@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: shettygururaj <gururaj.shetty@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: shettygururaj <gururaj.shetty@huawei.com>

This setup evolved into one using static symlinks.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: shettygururaj <gururaj.shetty@huawei.com>

* Fixed review comments and resolved all threads in MR.

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

Adding a definition we can use throughout the documents and having it
stated in the README.rst as a start.

Signed-off-by: Stefan Schmidt <stefan.schmidt@huawei.com>

Not used and also not correctly capitalized for the project name.

Signed-off-by: Stefan Schmidt <stefan.schmidt@huawei.com>

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

GitLab CI system has a constraint that requires all artifact files to be
placed in a sub-directory of $CI_PROJECT_DIR - aka the place where the
project is automatically checked out by the GitLab runner. Since our
project is manifest-based, we use a temporary scratch directory where
the entire structure is created.

Override `make` invocation, so that it builds the project from the
scratch directory into a build sub-directory of CI_PROJECT_DIR.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

* experimental will be dropped soon
* README.rst - is only meant as entry point
* project.rst - is only meant for CONTRIBUTING template

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The docs repository is now checked out in the root of the workspace, not
under sources/docs

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>