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>

- Move the Wayland evaluation document to concepts, adding a status to show
  it's out-of-date.
- Move the compositors in Wayland document to architecture
- Reinstate some images for the compositors in Wayland document that had been
  lost.

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

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

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

This demonstrates simple definition of policy roles and a sample policy
script written in Lua.

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

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

Fix minor issue that prevent page to be rendered properly.

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

Make the images even clearer with an explanation of what they are showing.

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

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

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

Start shifting the workflow guid towards a general high level overview of
the Apertis workflow. Add images to make the process easier to understand.

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

Make the platform guide more high-level, splitting out details into a new
workflow guide which will be reworked in a later commit.

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>

Monisha Muthukumaran authored 3 years ago and Monisha Muthukumaran committed 3 years ago

Signed-off-by: Monisha <Muthukumaran.Monisha@in.bosch.com>

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

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

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

Add the status to the technical vision document, adding a few more links
that we missing from the tables.

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

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

The web runtime concept is obsolete. Remove the documentation from the
website to avoid confusion.

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

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

Add the status to existing concept documents that require it and improve
layout where required.

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

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

The data sharing document is more of a architectural overview of how
data sharing is expected to be handled on Apertis. Move it to the
architecture section.

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

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

The App Store Approval page lists other pages that might be of note to an
App Store curators. As these are currently still concepts, as is the role
of app store curator, this page is not required.

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

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

A few extra terms/words have been found that are currently picked up by
the spell checker. Add them to the dictionary.

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

We have a number of concepts still in the "designs" folder from the old
layout that have yet to be reworked/updated. This is time consuming and it
would be great to have all the documents in a sane layout without loosing
track of the ones that still need updating. Put a status field and
description in the front matter and move out of designs.

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

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

The conditional access concept is broken into a design and a set of
implementation notes. Merge these documents into one to simplify document
structure and move to concepts. Add status and perform minor layout edits.

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>

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

Perform a few minor grammatical tweaks and move build infrastructure
document to architecture as it appears to be implemented.

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

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

- Document doesn't mention Shapwick which still seems to be built.
- Document mentions Corbridge that has been removed.

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