We want to ensure consistency and validity of the metadata and external
URLs provided in documentation. We currently have warnings in place for
broken external URLs, however as these checks are performed across the
entire site and only a warning (as it's not reasonable for someone to
fix up entirely unrelated links to get an MR accepted), there isn't
really a mechanism in place to ensure some targetted improvement as the
site is changed.

To remedy this, determine which files are added/modified in a given MR
and ensure that the sumbitter has corrected any broken links in the
documentation that they've touched and are providing the required
metadata.

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

Emanuele Aina authored 1 year ago and Martyn Welch committed 1 year ago

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

Emanuele Aina authored 1 year ago and Martyn Welch committed 1 year ago

Our targets have moved to a more modern stack a while ago.

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

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

Add additional benefits and guidelines to the test strategy document.

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

This variable allows packages maitainers to define which
instance of "test-cases" they want to use for testing.

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

Instead of using daily Apertis image, this option allow to build
a custom image which will be used in LAVA to test the package.

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

This describes the new change history files.

https://phabricator.apertis.org/T10148



Signed-off-by: Ryan Gonzalez <ryan.gonzalez@collabora.com>

Sietze van Buuren authored 1 year ago and Sietze van Buuren committed 1 year ago

Adds a new short-code to display all (nested) section pages in a link list (with
header title) with nested link lists for nested page sections. The order of the
list items resembles the page order in the navigation menu.

Usage:

Use the short-code in the markdown page the represents a subsection (a
subsection is represented by a markdown page and a subsection directory
(identically named) that resides in the same directory as the markdown page).

```
{{< section-toc title="Contents">}}
```

Note that the named input argument `title` is optional and defaults to
`Contents`.

Signed-off-by: Sietze van Buuren <Sietze.vanBuuren@de.bosch.com>

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

With this change, the short-code should accept both a single positional argument as well as named arguments.

Signed-off-by: Sietze van Buuren <Sietze.vanBuuren@de.bosch.com>

Sietze van Buuren authored 1 year ago and Walter Lozano committed 1 year ago

This commit adds an alignment argument to the svg short-code, in order to
make it more flexible. This allows to e.g. align an svg image to the
left. With this change, all svg shortcode input arguments are now named:
- `src`: svg file location (required)
- `alignment`: image alignment (optional, default: "center")

The current (old) implementation uses one positional argument (the svg file
location), whereas the (new) implementation in this commit uses two named
arguments. It is not possible to keep the first positional argument and add one
named argument, since Hugo does not allow to mix named and positional
arguments. Therefore, this short-code is not backwards compatible and all
existing svg short-code calls will have to be updated, when adopting this
change!

At least the first argument should be supplied as named argument. Thus, old code
like:

```
{{< svg "/path/to/svg-file" >}}
```

should be replaced with

```
{{< svg src="/path/to/svg-file" >}}
```

or

```
{{< svg src="/path/to/svg-file" alignment="left" >}}
```

if one wants to override the default alignment.

Signed-off-by: Sietze van Buuren <Sietze.vanBuuren@de.bosch.com>

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

Fix wrong link for v2024pre release notes.

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

Many pages feature a lot of text, which becomes cumbersome to read on
maximized browser windows on smaller screens (< 1920x1080). To improve
readability this commit introduces front-matter parameter to reduce the
page's text width to max. 800px. Tables and images are exlucded and not
narrowed to max. 800px to avoid problems.

The feature can be enabled by adding `isNarrowPage = true` to a page's
front matter.

Signed-off-by: Sietze van Buuren <Sietze.vanBuuren@de.bosch.com>

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

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

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

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

Currently v2024pre and v2025dev0 do not appear in the index of releases,
to fix that, add the missing index files.

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

Update the version of Apertis pointed to by the R-car setup guide and
the location of the firmware binaries. Provide direct links to the
required ATF firmware binaries.

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

Including SVG images using standard markdown disables certain features.
This commit adds a short-code that allows embedding SVG images. By
embedding the SVG image, its features are retained.
SVG features include clickable linked areas, hover texts, etc.

Usage example:
{{< svg "/images/example.svg" >}}

Signed-off-by: Sietze van Buuren <Sietze.vanBuuren@de.bosch.com>

u-boot from v2024dev1 has wrong default config and tries to do
a network boot.

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

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

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

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

Fit the mention to the current development release which was missed in the previous update.

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

Document the `<allowbuilddep name="*">` feature implemented to grant
unrestricted access to binaries in hidden projects.

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

Dylan Aïssi authored 1 year ago and Walter Lozano committed 1 year ago

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

Sietze van Buuren authored 1 year ago and Walter Lozano committed 1 year ago

- Add option to insert link after status description
- Only shown if status, statusDescription and statusLink parameters
  are non-empty
- If statusLinkText is set a linked text will be shown
- If statusLinkText isn't set a raw link is shown

Signed-off-by: Sietze van Buuren <Sietze.vanBuuren@de.bosch.com>

As systemd is an important component, include it in the list of new version
on the release notes for v2024dev2.

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

Martyn Welch authored 1 year ago and Emanuele Aina committed 1 year ago

We have an architectural document specifically labelled as only being
relevant up till Apertis v2021. We are no longer supporting this
revision and the document describes the use of Jenkins to perform image
building, which we no longer do. Remove this document and any links to
it in the rest of the website.

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

Since more and more information was added to explain the situation
around OpenSSL change the formatting to improve readability.

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

Update documentation regarding TLS stack after the new release of
OpenSSL 3.0.

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

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>

Signed-off-by: Dylan Aïssi <dylan.aissi@collabora.com>