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>

When a new release is branched, we need to ensure that a proper rotation
job is set for the respective release. In this example, we instantiate a
new timer for rotation of the images

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

For most major task, our user account suffice on OBS. But there are
certain exceptions, like creating new repositories, wherein we need
Admin level privileges.

This is required when we create new repositories for a stable release:
security, updates, backports.

Document this oddity that the user needs to have Admin level privileges

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

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

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

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

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

Merge the useful bits of the "wip" AppArmor documentation into the main
AppArmor document.

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

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

This documentation discusses how to download and modify a debian package
from OBS. Since we are using a gitlab based workflow these days, this
documentation is very miss-leading.

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

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

Missing word making sentence clunky. Fix it.

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

Emanuele Aina authored 4 years ago and Frederic Danis committed 4 years ago

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

Emanuele Aina authored 4 years ago and Frederic Danis committed 4 years ago

The "How to Make Your Code Reviewer Fall in Love with You" post provide
a nice and entertaining guide on submitting changes for review.

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

Recently people have been asking which kernel version is shipped on our
releases, and pointing them to the pkglist of the images to find the
right stanza didn't seem great.

Let's make that bit of information explicit in the recent release notes.

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

Some of the licensing provided for the packages listed in the TLS stack
document aren't right - correct them.

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

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

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

There is little to no utility carrying the 2+ year old weekly test
reports. Newer test reports are now reported on:

   https://lavaphabbridge.apertis.org/



The reports add siginficant bloat to the website and therefore to the
search file. Remove the reports and clean up any links to them.

Signed-off-by: Martyn Welch <martyn.welch@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>

* Update the main page to point to the latest old-stable release
* Update the release schedule
* Update the data file

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

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

A decision by Debian to treat OpenSSL as a system library has come to
light, which had not come to light at the time the original document was
written. Update the document to reflect this decision.

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

Take into account that maintainers may take resposibility for a single
component.

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

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

A basic template has been formulated to aid with writing concept documents.
Add this to the contributions policy and checklist.

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

We are currently pointing to the images policy instead of the download
page from the "Download the current images" link on the home page,
redirect this to the download page now we have one as that's more
relevant.

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

The shortcode is missing the ability to create URLs to ostree images. This
is vital since the download page should be serving OSTree images!

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

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

Now we have a download page, point to that rather than the image site in
key places. Update the image page to de-emphasise the Apertis images site
a bit (and prioritise the OSTree images) a bit more.

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

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

The Apertis website currently points users to the images site for
downloading images. This site contains a lot of different images and
presents a daunting number of options for those not versed in Apertis
images (like new users).

Create a page on the Apertis website that provides a much easier way to get
the currently recommended (stable, ostree) images. Add links to images
using a shortcode to make the download page easier to update.

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

The Apertis documentation refers to the role of maintainer in a number of
places, but never defines what the role entails. Add a section to cover
this role, linking to it from places where it is relevant.

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

The "contribution process" as much details Apertis' policies with regards
to contributions as laying out a process. Rename the page to simply
"contributions" to make the scope of the document a bit clearer.

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

The contribution checklist currently covers only a very narrow subset of
possible submissions, primarily new Apertis specific code and APIs. This is no
longer a major part of what Apertis is providing and many of the requirements
do not reflect current practice.

Remove the existing checklist and provide a new one that covers points to be
covered for code, component and design submissions, breaking down when and
where responsibility lies during the development and submission process.

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