Walter Lozano authored 3 years ago and Ritesh Raj Sarraf committed 3 years ago

In order to follow the best practices when upgrading components, change
branch name prefixes from wip to proposed-updates to trigger a license
scan.

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

The docker containers are stored under `/home/docker-data` and so are part
of the data saved in the persistent disk.

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

Format error on running command "aa-complain" line corrected.
"apparmor-utils" by defualt ships the command of "aa-status",
but on the latest version, "aa-status" shipped as separate
package, hence updated the warning to install the "aa-status"

Signed-off-by: Sudarshan C P <sudarshan.cp2@in.bosch.com>

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

The kernel update process contains a few minor errors and ommisions. Tweak
these to make it work better.

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

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

Minor updates, adding some more context and links to other documents,
fixing a few issues.

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

Skip another set of redirects so it's less likely that validating links
makes us fall into rate limiting.

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

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

GNOME has moved from git to GitLab. The default redirection is assuming
projects have a "master" branch, whereas some are using "main", resulting in a
404.

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

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

We link to the hardware reference page from the home page, as a result this
page is likely to be one which is visited by people generally unfamilar with
Apertis.

We should not promote the use of daily images to those likely to be looking to
evaluate Apertis - they should be using the stable images.

Booting non-SDK images in VirtualBox is not a supported option, so whilst it
works for many images, this is not guaranteed (and the minimal OSTree images
are known not to boot in VirtualBox). Set expectations with regards to running
in this configuration.

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

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

The licensing documentation is linked from the home page, but is a bit of a
mess, with guidance on documenting licensing and information about the Apertis
licensing scanning infrastructure mixed with Apertis licensing policies.

Split out the license scanning documentation into a separate architecture
document. Move the small amount of policy documentation from the applying
licensing document and move to guides.

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

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

The components which comprise the application framework are mentioned in many
places in the Apertis website. Make it clear that these components have been
removed as of the v2022dev2 release.

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

Ritesh Raj Sarraf authored 3 years ago and Martyn Welch committed 3 years ago

Because base-files is important as in it contains all the necessary
metadata pertaining to the release, ensure that it is built proper.

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

In order to make it clear the preferred approach to deal with different
scenarios of licensing issues, add additional tips and examples.

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

When first importing a package, the `Run pipeline` button doesn't appear
in Gitlab's UI and a workaround is needed to trigger the first pipeline.
This commit adds a tip for such situations.

Signed-off-by: Arnaud Ferraris <arnaud.ferraris@collabora.com>

A scan of external links has shown numerous places where external links are
broken, fix them.

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

A scan of "external" links are showing numerous places where links point to
supposedly Apertis provided content which is now gone. Fix these or remove
links.

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

Signed-off-by: Arnaud Ferraris <arnaud.ferraris@collabora.com>

The v2019 release has reached the end of its support period. It also marks the
point at which we are now fully into the current Apertis release cadence, with
a development, stable and old stable release being supported.

Remove the pointer to the "old old stable" from the main page, the data from
the releases file and the reference to the supported version of Virtual Box.

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

Martyn Welch authored 3 years ago and Martyn Welch committed 3 years ago

It is frequently important for device manufacturers to harden the devices that
they produce, in order to ensure that their devices continue to comply with
required regulations and protect against compromise by malicious third parties.

Provide documentation highlighting techniques that can be used to harden an
Apertis based device.

Update dictionary to include words and acronyms wrongly picked up as spelling
mistakes.

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

Current SDK images requests to manually setup the Virtual Machine in
VirtualBox, as we're only provinding the disk image (.vdi file).

Support to generate a VirtualBox Appliance image (.ova file) that works
out of the box has been recently added to `apertis-image-recipes`.

Starting Apertis release version `v2022`, SDK images will be uploaded in
OVA format. Let's document that and still keep the previous `.vdi` disk
image setup for old versions reference.

Signed-off-by: Ariel D'Alessandro <ariel.dalessandro@collabora.com>

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

It seems that quite a few people have added links to the packaging guide,
add in an alias to make sure we catch these when they've not been updated.

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

We are now beginning to use "+apertisX" rather than "coX" for Apertis changes.
Tweak the description of versioning to use this new string.

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

There is a very kernel specific workflow in the component guide, move this to
the kernel specific document where it makes more sense.

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

The workflows in component guide target Apertis maintainers more than
developers, it is also out-of-date in some places. Update this guide and make
it more relevant to non-maintainers in the process.

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

Signed-off-by: mtt2hi <thomas.mittelstaedt@de.bosch.com>

Martyn Welch authored 3 years ago and Martyn Welch committed 3 years ago

The information about the workflows and repository structure is all
jumbled up. Rename and sort the documentation into high-level
information, workflows and repository layout.

Shift more detailed documentation found in this document into more suitable
locations, rewording/adapting as required.

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

Martyn Welch authored 3 years ago and Martyn Welch committed 3 years ago

There are two sections that indirectly point to the packaging guide.
Remove these as they don't really add anything.

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

Martyn Welch authored 3 years ago and Martyn Welch committed 3 years ago

The packages have been moved from repository based subdirectories under
`pkg/` to `pkg/` its self. Update the URLs used on the website to reflect
this.

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

Martyn Welch authored 3 years ago and Martyn Welch committed 3 years ago

The remaining documents in designs are completely obsolete. Remove these
designs to avoid confusion. The designs folder is part of the legacy
layout so remove it completely now that there's no documents. Fix any
broken links.

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

Martyn Welch authored 3 years ago and Martyn Welch committed 3 years ago

The connectivity document is more of a guide on how to implement support
than a concept. Add status to page as it is out of date, but move to
guides as this is the "right" place for it.

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

We have added the new Terms of Use and Privacy Policy to the website and
in-line with the existing policies we state we will give 30 days notice of
change.

Note: These changes will switch to the new policies and should not be
merged until the 6th May 2021.

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

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

The Apertis packaging toolchain and pipelines have switched from the
`coX` packaging version suffix to `apertisX` to better distinguish the
work of the Apertis team from more Collabora-specific packages.

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

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

The Apertis packaging toolchain and pipelines have switched from the
`coX` packaging version suffix to `apertisX` to better distinguish the
work of the Apertis team from more Collabora-specific packages.

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

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

The Apertis packaging toolchain and pipelines have switched from the
`coX` packaging version suffix to `apertisX` to better distinguish the
work of the Apertis team from more Collabora-specific packages.

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

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

Removing default code highlighting requires us to explicitly mark code we
wish to be highlighted. Tweak howtobuildyourownkernel.md to act as a show
case of how to do this.

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

Signed-off-by: Andreas Elvstam Cantner <andreas.elvstam@se.bosch.com>

This commit enables the generation and display of the ToC on all pages
where it's relevant due to the content size.

More pages could have been included but left aside due to inconsistent
use of heading levels leading to rendering/visual glitches.

The pages' content has not been modified, except for the "Terms of use"
page which included a manually-generated ToC.

Signed-off-by: Arnaud Ferraris <arnaud.ferraris@collabora.com>

Arnaud Ferraris authored 3 years ago and Martyn Welch committed 3 years ago

Signed-off-by: Arnaud Ferraris <arnaud.ferraris@collabora.com>