Signed-off-by: Emanuele Aina <emanuele.aina@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>

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>

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>

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

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>

Described the switching between ostree branches (aka "upgrade
major version") during offline upgrades.

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

Starting version v2020.7 `libostree` upstream provides deltas with
[signed metadata](https://github.com/ostreedev/ostree/pull/1985

)
allowing to validate the creator of the delta file itself, not only
the commit inside.

Add information about affecting this upstream change to Apertis.

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

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

The persistent workspace documentation is currently in the SDK usage document.
The usage document covers some very basic usage, whilst the persistent
workspace is a little bit more of an advanced topic. Split it out into its own
document and move both to guides.

Additionally the design document is still present for the persistent workspace
feature. This is now redundant since the design has been implemented. Move the
limited amount of pertanent information from the design document to the guide
and remove the design document to avoid confusion.

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

Martyn Welch authored 4 years ago and Peter Senna Tschudin committed 4 years ago

Move documents out of designs and into more suitable locations following
the layout guidelines.

Perform some minor edits to correct typos and remove unneeded titles.

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

Signed-off-by: Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>

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

This document describes how we built images on Jenkins, but we have now
largely moved away from it in favor of GitLab CI/CD.

The README in the infrastructure/apertis-image-recipes> project
describes the current setup closer to the actual code.

Keep the document around since v2019 and v2020 are still officially on
Jenkins and old release notes still point here.

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

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

Now that we have largely moved away from Jenkins to GitLab CI/CD the
document describing the benefits of using Docker with Jenkins no longer
add much value.

The switch to Docker has proved immensely useful and has been a
fundamental piece for our ability to move to GitLab CI/CD, and in 2020
Docker is widespread enough in the industry that there's no longer a
real need for Apertis to rehash the benefits it brings.

Let's drop the document now that it has been fully implemented and
that we moved the CI/CD architecture even further, making the
document obsolete.

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

The license expectations document is a little out of date. Tweak it a bit
and move it along with the license-exceptions document to policies.

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

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

This concept document describes a possible approach to closing the CI loop
using Jenkins. Apertis is moving away from the use of Jenkins and so this
document is now defunct. Remove it.

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

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

The selection of images as defined for the v2019 release has been used for
a number of releases. This is no longer an open concept, add the
documentation to the images page and remove the concept document.

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

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

The license-validation document covers the same ground as the first
portion of the automated license compliance documentation. Drop it to save
duplication of information.

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

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

The design documents imported from designs.apertis.org need to be
classified and moved into the structure implemented for documents on the
new website. The content of the documents also need minor edits to ensure
a good look and feel as well as the addition of notes to explain the
context of some documents (such as noting that certain concept documents
have been implemented since they were written and when that occurred).

This commit contains conversion of an initial batch of design documents.

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

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

Got out of step whilst adding creation dates to designs and failed to test
properly. A stray space is stopping the dates from being parsed. Remove
the space.

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

The old designs.a.o site holds versioned copies of the designs. We are not
going to present these any more, so where appropriate, link to the latest
copy of the document rather than returning 404.

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

The metadata in each file on designs.apertis.org didn't contain a creation
date, however this is the primary means that we are ordering the documents
by on the new Apertis website so that the newer documents are listed
first.

Whilst the documents don't contain a creation date, they are stored in a
git repository that can provide us with this information. Add the
retrieved dates into the front matter.

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

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

We are using Hugo's "ref" shortcode for links on the website as this helps
to ensure that our links are valid. A number of links that aren't using
this tool have been identified, fix them and the resulting bad page links
found un upstreaming.md.

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