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>

As some of our pages include a lot of content, structured through the
use of headings, it makes sense to include an auto-generated ToC in our
template.

This ToC is only generated for pages including the `toc` boolean
parameter with value `true` in their source header, so it can be enabled
only when really useful.

It only includes elements from heading levels 2 and 3 by default, while
most of our documents are structured by using levels 1 and 2, so this
commit also includes changes to the config file to reflect that.

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>

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

It can often be instructive to know how old a document is, it can be
surmised that a document written days ago may be more accurate than on
written years ago. to enable users of the website to easily determine this
add the last modification date to each document.

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

Add some pointers for the style that we expect in Markdown submitted for the
Apertis website. These are things that get picked up in review, stating them
upfront may reduce the time needed to review submissions.

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

Improve documentation by providing an example of debos overlay action to
apply customizations to images.

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

A warning was missed whilst implementing the source file link:

    .File.Path on zero object. Wrap it in if or with: {{ with .File }}{{ .Path }}{{ end }}

Update to use the recommended format.

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

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

In order to make it easier for users to discover where to edit the
website, add a link in the page footer pointing to the current page in
GitLab.

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>

Fix double "the" in the OP-TEE document.

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

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

Provide some updates to clarify issues raised by the document review.

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

Starting with Apertis v2022dev2, `Flatpak` is also able to use `Ed25519`
cryptography.

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

The document was written before all communication applications moved to
closed silos, back when XMPP was commonly used. The tradeoffs in the
document no longer apply and the strategy should be revised.

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

Change 'journactl' -> 'journalctl'

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

Sjoerd Simons authored 4 years ago and Sjoerd Simons committed 3 years ago

This document tries to outline at a quite high level the types of
devices and scenarious Apertis tends to support to give potential users
a starting point for considering apertis.

For each sections tables are provides with references to more detailed
documentation section to drill into further technical depth.

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 3 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 3 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 3 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>

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

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

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

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

Walter Lozano authored 3 years ago and Emanuele Aina committed 3 years ago

Since when using OSTree folder /home is writable and preserved across
updates clarify this to avoid misunderstandings and to be consistent
with the rest of the document.

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

Walter Lozano authored 3 years ago and Emanuele Aina committed 3 years ago

In order to clarify that the principles describe in preferences and
persistence also apply to Flatpak add a small reference to it.

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

Walter Lozano authored 3 years ago and Emanuele Aina committed 3 years ago

Remove a line that was repeated by mistake in system updates and rollback.

Signed-off-by: Walter Lozano <walter.lozano@collabora.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 3 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>