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

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

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

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

The current theme uses ".URL" in a number of places that is resulting in
the current warning message:

    Page.URL is deprecated and will be removed in a future release. Use .Permalink or .RelPermalink. If what you want is the front matter URL value, use .Params.url

Update the usage of this variable to ".Permalink" to stop the warning
messages being produced.

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

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

The variable ".Hugo" has been deprecated syntax since v0.55. We get a
warning about this each time the site is built:

    Page.Hugo is deprecated and will be removed in a future release. Use the global hugo function.

Tweak the theme to utilise the correct new syntax to remove the errors
making it clearer what is happening when something goes wrong.

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

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

After moving to the latest version of Hugo, we are seeing lots of warnings
as follows:

WARN 2021/03/08 10:11:09 Failed to get translated string for language "en" and ID "postedOnDate": template: :1:13: executing "" at <.Count>: can't evaluate field Count in type string

The fix is trivial, so implement to save these messages from obscuring
actual issues.

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

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

We have been using an old version of hugo in the gitlab registry as the
latest version available at the time this was setup had a show stopping
bug. Update the version of hugo used and switch to the docker image
recommended by the Hugo project as this is potentially easier for those
behind restrictive proxies to access.

Provide a helper script to also make it easier to run Hugo from docker as
a developer and document it. Use the `--rm` option to cause docker to
remove the container once it's exited to avoid them building up and add
`--security-opt label=disable` for those using an SELinux enabled
distribution.

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

The use of custom domain names to access uptimerobot status pages has been
made part of the pro plan. As we don't currently have a pro plan, update
the website to use the direct URL.

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>

The copyrights document refers to the "Creative Commons
Attribution-ShareAlike 4.0 Unported" license. Provide a link to
the license so that more information about it can be easily
found.

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>

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>

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

Hugo has a newer set of config options to control highlighting. Use them.

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

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

Hugo has built in support for build time highlighting via Chroma. The
Beautiful Hugo theme is also enabling Highlight.js. Disable Highlight.js
so that we can gain control over the highlighting from the site config.

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>

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>