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>

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

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>

Extended "Apertis integration testing with LAVA" guide with additional
details.

Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Arnaud Ferraris authored 3 years ago and Peter Senna Tschudin committed 3 years ago

The "Publishing a single application" section introduces the use of
.flatpakrepo files, which are detailed in the subsequent "Publishing a
repository" section. Moving the latter section before the former
therefore makes more sense.

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

Arnaud Ferraris authored 3 years ago and Peter Senna Tschudin committed 3 years ago

As requested, this commit adds more detailed explanations and
step-by-step commands for creating and installing signed flatpak
applications.

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

It has been dropped in the packaging-tools repository

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

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

One exception case, that of maintaining a package from an independent
upstream source tarball, was documented separately.

This was causing confusion to us all as this content wasn't reflected on
the master page, i.e. Apertis Packaging Guide

This patch just moves the content to the right location

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

Change 'journactl' -> 'journalctl'

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

Update and re-shuffle the existing parts of the apparmor.md guide
to merge the old guide with the new guide:
 - Update summary with new ref links.
 - Reused a few sections but rephrased and updated references.
 - Removed a few, no longer needed, sections.
 - Fix minor formatting

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

Rewrite introduction to reflect the newly updated guide on AppArmor and
profile development. Briefly mention that DAC and capabilities are not
considered in the guide but considered prerequisites.

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

Apply 2 suggestion(s) to 1 file(s)

Summary of content:
 - Introduction to mount rules in AppArmor
 - Short explanation of correlation between CAP_SYS_ADMIN and mount
 - 2 examples for profiles that allow mount operations.

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

Jasarevic Samir authored 4 years ago and Elvstam Cantner Andreas committed 3 years ago

Signed-off-by: Samir Jasarevic <samir.jasarevic@se.bosch.com>

Signed-off-by: Samir Jasarevic <samir.jasarevic@se.bosch.com>

Jasarevic Samir authored 4 years ago and Elvstam Cantner Andreas committed 3 years ago

MAC-DAC-example.png figure added to the AppArmor guideline.

Signed-of-by:  <samir.jasarevic@se.bosch.com>

Introduction to file access in AppArmor.
An example of MAC and DAC file access permissions is shown.

Signed-off-by:  <samir.jasarevic@se.bosch.com>

Apply 4 suggestion(s) to 1 file(s)

Apply 1 suggestion(s) to 1 file(s)

Apply 1 suggestion(s) to 1 file(s)

Apply 2 suggestion(s) to 1 file(s)

Updated file access based on the review comments.

Signed-off-by:  <samir.jasarevic@se.bosch.com>

Update file access with 4 spaces for code

Signed-off-by:  <samir.jasarevic@se.bosch.com>

Elvstam Cantner Andreas authored 4 years ago and Elvstam Cantner Andreas committed 3 years ago

The current guideline on AppArmor covers basic overview and breifly mentions development
steps needed. This commit extends the AppArmor guideline with more in-depth development
steps and examples for how to developt AppArmor profiles.

Sections included:
Profile Introduction
 - Profile Modes
 - System Logs
Profile Development
 - Manually Write The Profile
 - Tool Aided Profile Development

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

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

Apertis now has open registration on it's GitLab instance. Update the
documentation to reflect this.

Correct some spelling mistakes and grammatical issues noticed when reading
documents.

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

Signed-off-by: Peter Senna Tschudin <peter.senna@collabora.com>

Denis Pynkin authored 4 years ago and Peter Senna Tschudin committed 3 years ago

Added the guide how to create Apertis tests for LAVA.

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

Ariel D'Alessandro authored 4 years ago and Martyn Welch committed 4 years ago

Debian upstream version tag should start with debian/ instead of
apertis/. Fix this.

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

Arnaud Ferraris authored 4 years ago and Emanuele Aina committed 4 years ago

Using multiple occurrences of the `--sign-verify` option can be used to
configure a remote while a new signature key is being rolled out. Add a
paragraph explaining that use case.

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

Arnaud Ferraris authored 4 years ago and Emanuele Aina committed 4 years ago

This commit includes suggestions from reviewers and fixes the following
issues:
* use `ref` macros for internal links
* fix minor grammar and spelling issues
* add a warning regarding the preliminary state of Ed25519 support

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

Arnaud Ferraris authored 4 years ago and Emanuele Aina committed 4 years ago

This commit adds a user guide explaining how to create flatpaks signed
with the Ed25519 algorithm, and how to verify such flatpaks.

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

Elvstam Cantner Andreas authored 4 years ago and Martyn Welch committed 4 years ago

Change from localhost to proper link address for /policies/upstreaming
referenced from apparmor.md

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