Andrej Shadura authored 4 years ago and Emanuele Aina committed 4 years ago

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Andrej Shadura authored 4 years ago and Emanuele Aina committed 4 years ago

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Andrej Shadura authored 4 years ago and Emanuele Aina committed 4 years ago

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Andrej Shadura authored 4 years ago and Emanuele Aina committed 4 years ago

The diagram comes in two formats:
 - SVG with editable text (apertis-dep-14-gitlab.svg)
   This is the primary source.
 - SVG with texts as paths (apertis-dep-14-gitlab-curves.svg)
   This is generated from the primary source; it is a preferred
   format for embedding as a figure in a document, since it
   doesn’t depend on the availability of fonts or the renderer’s
   ability to render them correctly.

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

Whilst we call out specific policies in the contribution checklist, we
should make sure that any contributions made to Apertis do not violate any
of Apertis' policies. Explicitly add this to the contribution checklist.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Since we are editing the development process, use this an an
opportunity to improve the spelling in the document and the website's
custom dictionary.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The development process states that a "Fixes: APERTIS-<task_id>" tag
should be added to relevant commit messages. At some point we had
functionality in place to automatically add comments on the Phabricator
task when such tags were present. I don't believe that this
functionality is still in place, hence the description is missleading.

This is also not something that I have seen being used (a lot?) by core
maintainers. Since this is not common practice we should remove this
requirement, simplifying the documented process for new contributors.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

The website is using a mix of serif and sans-serif fonts, switch to using
sans-serif throughout site to make it more uniform.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Thanks to Sudarshan for spotting it!

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Add to the platform document and introduction to the image generation about
debos and the versatility it provides to build customized images.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

Improve the system updates and rollback document with information about
OSTree and how to handle settings.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

Update documentation regarding system updates and rollbacks with information
about dpkg and deb packages.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

To improve the general idea include recommendations regarding rollbacks
to build a more secure and robust solution. Also add a section to introduce
the requirement to handle settings during upgrades and rolbabacks.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

Update the hawkBit document "preparing-hawkbit-for-production.md" based on
the review comments that have been received so far.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

A new point release has been published to include the linux kernel
5.10.x LTS version, which upstream didn't released in time for inclusion
in v2021pre.0.

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Thank you @andrewsh for spotting it.

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

The titles in the supported virtualbox table are a bit messy. Clean them
up a bit.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

A few issues were missed when reviewing the addition of a table of
supported virtualbox versions:

- There's an additional "{" on one of the shortcodes that's getting
  rendered in the final page.
- The table is missing a column marker and is thus not getting formatted
  as a table.

Fix these two issues.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Benani Sagar Kishore authored 4 years ago and Martyn Welch committed 4 years ago

officially supported by Apertis for each release.

The IMA paragraph in the Apertis security section contains some
non-valuable information as well as an external link that cannot
be resolved because the referenced page was shut down.
Both parts were removed.

Signed-off-by: Tino Lippold <Tino.Lippold@de.bosch.com>

Correct several external links in Apertis designs/security section.

Signed-off-by: Tino Lippold <Tino.Lippold@de.bosch.com>

Martyn Welch authored 4 years ago and Frederic Danis committed 4 years ago

The consistency of spelling on the Apertis website isn't great. We use UK
English in places and US English in others. This could get problematic
when users are looking for documents describing artifacts when we've spelt
it "artefacts" in some relevant documents.

Let's start the process by documenting the use of the Aspell spell
checker. Start building a custom dictionary of acceptable terms, with the
plan of integrating this into the CI/CD process at some point in the
future.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Frederic Danis committed 4 years ago

The long term reproducibility document doesn't utilise the formatting
available in Hugo overly well and contains a number of uses of UK English
and terms that aren't widely used.

Tweak the document to use US spelling and more common terms. Make use of
Hugo formatting capabilities where sensible.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Frederic Danis committed 4 years ago

A template has been introduced for concept designs. Modify the flow of the
document to fit the template.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Frederic Danis committed 4 years ago

This commit adds a concept document covering recommendations on work to be
carried out before the Apertis hawkBit instance could be used as a
reference for a production deployment system.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Frederic Danis committed 4 years ago

The software distribution and updates document covers attributes of the
distribution and update process that are not yet fully present in Apertis.
It is therefore much more suited to the concepts section of the
documentation.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Fix the broken links on the properties listed as examples by pointing
them to their entries in the VSS Ontology (VSSo) document.

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Rather than using a quoted section, just inline the link.

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Fix a broken link by pointing it to the page describing how to extend
the data with private branches.

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Spelling `camelCase` in snakeCase is confusing, so really
use `CamelCase`.

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Fix a link by no longer escaping special character since Hugo is smart
enough to not need that.

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>

Tino Lippold authored 4 years ago and Emanuele Aina committed 4 years ago

Signed-off-by: Tino Lippold <tino.lippold@de.bosch.com>

Walter Lozano authored 4 years ago and Emanuele Aina committed 4 years ago

Add a document to describe the coreutils replacement with a GPL-3-free
alternative. Include different options in a comparison and a plan for
the transition.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>