Davide Ricci authored 3 years ago and Stefan Schmidt committed 3 years ago

Highlights of the change:
- Remove OpenHarmony as main brand name.
- Introduce All Scenarios OS as description.

Signed-off-by: Davide Ricci <davide.ricci@huawei.com>

Davide Ricci authored 3 years ago and Stefan Schmidt committed 3 years ago

In no particular order:
Removed partners name.
Moved features list above target list.
Added QEMU targets.
Adjusted big rocks released features and removes lower level functionalities in order to tell a story.

Signed-off-by: Davide Ricci <davide.ricci@huawei.com>

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

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

* The development of the these capabilities, removed 'the' for
  grammatical error, fixes issue#75

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

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

The generic pipelines triggers the build docs jobs based on the
assumption that the documentation build directory is in a docs
subdirectoy. That is not the case in the docs repository which uses the
repository root for the build directory.

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

The generic pipelines triggers the build docs jobs based on the
assumption that the docs are in a docs subdirectoy. That is not the case
in the docs repository which includes only documentation.

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

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

The .workspace and .build-docs allow simplification of the two similar
jobs present into this repository. The .workspace job completely
replaces the local copy, with a single configuration variable to enable
testing of incoming changes.

The build job becomes build-docs and extends both the .workspace job and
the .build-docs job, reusing both the scripts to perform everything that
was formerly specified explicitly.

The deploy job now extends the .workspace job but is otherwise
unchanged.

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

The ci used to be a document in the manifest repository (aggregated in
docs as a symlink). On the manifest repository side, the topic was
restructured switching ci to a directory. Fix the reference in the docs
aggregation.

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

Focus on the key objectives (deliver a first set of milestones with
partners) in this notes. Other parts can move into the general project
documentation over time.

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

With the 0.1.0 release done we are now back in development mode.
Indicate this by setting the version to 0.1.99. If we ned to provide
stable update releases to 0.1.0 they will come from a release branch as
0.1.1 .. 0.1.n.

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

Relates to #60

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

Signed-off-by: Sebastian Serewa <sebastian.serewa@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: Stefan Schmidt <stefan.schmidt@huawei.com>

Bernhard Rosenkränzer authored 3 years ago and Andrei Gherzan committed 3 years ago

The incorrect number of spaces in front of the * characters caused them
to be rendered as literal * characters instead of a sub-list

Signed-off-by: Bernhard Rosenkränzer <bernhard.rosenkraenzer.ext@huawei.com>

Chances are not everyone wanting to contribute has heard of SPDX -- provide
a link to what it is on the first mention

Signed-off-by: Bernhard Rosenkränzer <bernhard.rosenkraenzer.ext@huawei.com>

Amit Kucheria authored 3 years ago and Andrei Gherzan committed 3 years ago

The features we are talking about are not currently fully functional.
Make sure that readers understand that.

Signed-off-by: Amit Kucheria <amit.kucheria.ext@huawei.com>

Arul Kumaran authored 3 years ago and Andrei Gherzan committed 3 years ago

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

The manifest repository now contains standalone documentation which is
aggregated under `repos/manifest`. The section about testing in
`ci/manifest.rst` is replaced with a short reference. This effectively
completes the move of CI documentation from the docs repository to the
manifest repository.

This leaves an open question on how to handle the meta-ohos repository,
which also contains general build system documentation. As a likely
special case, this is not discouraging and I would like to keep adding
other repositories into the `repos/` structure.

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

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

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>