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>

Give some more contetx about the Apertis approach to standalone tests
and update the instructions to be more detailed and reflect the
current status (bye bye Jenkins).

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

To make Martyn happier, let's avoid breaking hyperlinks over
multiple lines.

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

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

Whilst reworking the glossary, a number of layout improvements and broken
links were identified in the documents which the glossary point to. Fix
these minor issues.

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

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

Rework the glossary using a custom Hugo shortcode. This should give us
more flexibility over the layout of the glossary without needing to
completely rework it again and reducing the amount of embedded HTML
without loss of functionality.

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

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

The documented update mechanisms do not actually include the process used
currently for online updates. Add a section providing a basic description
of the currently implemented strategy.

Whilst here, rework the least visually conformant image to fit better and
run the document though a spell checker.

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

The test data based concept documents describe a test system that was
not implemented. Remove most of the bits that are no longer relevant and
move the updated documents to the QA section.

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

These documents appear to be concepts that are still open (though some
quite stale). Move them to concepts to get the designs section removed
soon.

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

Fix several link issues found in application-layout.

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

Fix some formatting issues, remarks and command names.

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

Walter Lozano authored 4 years ago and Martyn Welch committed 4 years ago

As currently the infrastructure repository uses only a master branch update
the links accordingly.

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

The default `libneon27` package in Debian is built against OpenSSL,
https://packages.debian.org/sid/libneon27



The GnuTLS backend is enabled in the `libneon27-gnutls` binary package.

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

The new Debos backend autodetection was misreported as part of v2021pre
but has not been actually landed there while it is part of v2022dev0.

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

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

We state that authors of submissions to extend existing components could
be asked to submit the change upstream, however we do not cover the option
of using a dedicated project area for tweaked components should changes
not be of general applicability to Apertis.

Highlight that dedicated project areas may be made available for this
purpose.

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

Frederic Danis authored 4 years ago and Peter Senna Tschudin committed 4 years ago

Target devices with limited computing power(such as a single core, or just
a little bit of RAM) may fail or need a long time to open encrypted files
that were not created for small devices. This patch adds documentation
that explain how to create encrypted files that are suitable for small
devices.

Signed-off-by: Frédéric Danis <frederic.danis@collabora.com>

Denis Pynkin authored 4 years ago and Emanuele Aina committed 4 years ago

Starting Apertis v2021dev3 we have full support of all ostree
capabilities as we have for SabreLite board. To support all features
U-Boot should be updated to version 2020.04+dfsg-2co5bv2022dev0b2 or
later.
Set proper links to proper U-Boot version and images in setup documentation.

Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>

As a reference for the installation of Automated License Compliance add a
guide to pointing to the pieces of software to be installed and upgraded.

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

Walter Lozano authored 4 years ago and Peter Senna Tschudin committed 4 years ago

Update documentation about Automated License Compliance based on the current
development status reflecting some of the decision that have been made.

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