This provides more consistency with the other sections.

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

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

Closes #61

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

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

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

We want at least pdf available.

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

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

This was basically just a git tutorial. We can resurrect it if we find
it valuable in the future.

This is also the last topic in the section so we can drop it from the
root index as well.

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>

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>