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

The QA area hasn't had any love for a long time. Remove the bits that we don't
use any more or that are superfluous given how the site indexes pages. Add
links to some of the new QA related tools developed for Apertis.

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

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

The Apertis website isn't a blog, switch from the "posts" terminology to
"documents" which is much more inline with what we have on the site.

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

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

The Apertis theme doesn't support social media icons in its footer. Remove the
data.

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

Tweak the information on the homepage to sell Apertis a bit better. Ensure the
links are the best ones that we can provide.

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

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

The theme provides an archetype of a new document to aid adding pages. This is
out of date and doesn't provide the front matter we expect. Modify it to
provide the minimum expected front matter.

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 homepage currently uses a very standard layout, which doesn't provide
a very compelling initial impression. Improve the layout to give the
website a more professional feel, as implemented by Jon Wallace but replace
`DIVclass` with distinct shortcodes.

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

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

The Apertis theme uses a shortcode called `DIVclass` to allow
semi-arbitrary CSS to be applied. Simplify this for document writers by
spliting the responsive table functionality (demoed on the bundle spec) as
a separate shortcode.

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

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

Update the configuration to use the newly added custom theme.

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

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

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>

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

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

In order to ensure we are notified of broken URLs, add testing of external
URLs as a step in the CI. It is added as `allow_failure` because it would
be inapproprate to stop merges because an unrelated link has broken.

Additionally, only test when CI is run on master branch to save repeatedly
testing the URLs each time a merge request or branch is updated.

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

We have release notes for lots of old releases on the website. These are kept
as they show the project has significant history, however a lot of the
information contained in them is likely to be very out of date. Add a warning
to the top of the old releases to note that they are deprecated and remove any
now dead links.

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

We have external links looking for the API document in designs, which no longer
exists. Add an alias to support this rather than returning 404.

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>

The Apertis website contains many links, some of these will be dead. This
script parses the Markdown documents to find links which are then made into
a unique list and tested.

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

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

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

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

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

Signed-off-by: Emanuele Aina <emanuele.aina@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>

The packages concept came from the old wiki. It more or less duplicates the
content listed in the "Platform APIs and Services" architectural document, but
also lists a number of packages that have long since been removed from Apertis.
Perform a quick tidy up, moving any potentially useful/relevant information to
the architectural document and deleting the packages page.

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

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

Add a link to the dashboard sub-section where we generate and store the
Apertis package indices, per release, in TSV format

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

Sagar authored 3 years ago and Arikkala Vijeth committed 3 years ago

Signed-off-by: Sagar <SagarKihore.Benani@in.bosch.com>

Update the table listing the GPL-3 deltas from Debian by

- Add additional entries with deltas
- Reword comments to be consistent with the category

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

In an effort to keep deltas due to licensing issues to a minimum
document the current status and propose alternatives for the different
packages involved.

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

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

The cgroup-v1 documentation has moved, correct the link.

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

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

The security document states to "see the Multiuser design document" without
providing a link. Add one to aid users.

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>

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

In 334c0498 a hack was added to force anchors to be visible (and not hidden
behind the navigation bar) when following a link with a fragment. This was
achieved by setting a large top padding and negative top margin.

This hack had the unintended consequence that when there is a title too close
to the top of the page, the transparent padding of the title (which forms part
of the title) covered the "Also available in PDF format" link, making it
inaccessible.

Modern CSS has a `scroll-margin-top` attribute that can be used to correctly
set a scroll margin (which is what is needed to properly fix the original
issue). This seems to have broad adoption in modern browsers and this attribute
failing to work isn't the end of the world anyway.

Tweak the CSS to use this attribute to replace the previous hack.

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

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

Currently, Apertis CI pipeline uses scan-copyrights Perl tool to
generate and update the copyright report. However, this is not
documented anywhere in the website, only fossology is mentioned as a
future improvement.

Let's document the current scan-copyrights approach.

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