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

These documents can be moved to guides more or less as they are.

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

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

The build and integration infrastructure documentation page mainly
covers a description of how the binary package versioning is formed.
Rework the page to present this information in a slightly more rounded
way and move it to the archtecture section.

We can forgo a list of the services, links to the services should be
provided where they are needed. We need to remove the link to
mattermost history as that is not publically accessible.

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

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

We are rapidly moving from Jenkins to GitLab CI. Remove the
documentation regarding Jenkins as this is of verly little to no use
now.

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

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

The version control guide looks useful, but is a little out of date.
Update the guide to use current workflows and move to `guides/`.

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

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

The following guides can be moved to `guides/` with minimal changes:

- buildingpatchingandmaintainingtheapertiskernel.md
- gitlab-based_packaging_workflow.md
- howtobuildyourownkernel.md
- howtodevelopondevices.md
- logging.md

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

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

The mainly lists the pages found under `guidelines/`, as the hugo site
now automatically lists these. The rest of the information on this page
is also either broadly out of date or of negligable value. Remove the
index completely as we will be removing the guidelines section anyway.

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

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

The README.md is currently the stock one added by the gitlab Hugo
template. Make the README.md more relevant for the Apertis website and
provide some information on how to cause PDFs to be generated.

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

We currently have no PDFs being generated. Add the required frontmatter
to the existing concept documents to cause them to have PDFs generated.

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

Apertis currently has a large number of concept documents on
designs.apertis.org. To improve branding, searchability and reduce
maintenance, it would be better to have all these documents under the
main website. One feature that the website is currently missing that is
provided on designs.a.o is PDF generation, which is used when reviewing
concepts with Bosch.

Carry over the PDF generation functionality from designs.a.o and
implement a mechanism for generating PDFs from the Hugo site on
www.apertis.org so that we can move documents over from designs.a.o
without loosing needed functionality.

To do this we will generate simplfied HTML documents, with the
extension `.pdf-in` when documents require this to be generated in
their frontmatter, for example to generate html and the simplified HTML
add:

    outputs = ["html", "pdf-in"]

The create-pdf script will be run for each of these via the CI pipeline
which will use a lightly modified version of the tooling used for
designs.a.o to create the PDF and place it back into the site.

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

Martyn Welch authored 4 years ago and Andrej Shadura committed 4 years ago

This reverts commit 04c35e0b.

Martyn Welch authored 4 years ago and Andrej Shadura committed 4 years ago

A lot has changed with the Apertis project since the privacy policy seems
to have last been revisited. I have attempted to update this policy to
reflect the fact we no longer run a mediawiki instance, but we do have
gitlab that has user accounts.

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

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

We no longer have any content in `docs`. Remove this directory, tweaking
links where possible to relevant locations. As part of this, make sure the
new `guides` and `architecture` sections are linked from the main page.

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

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

This is no longer the strategy used to define supported APIs, remove the
document.

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

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

This page documents an investigation that was carried out looking at
MxLauncher. This is no longer a part of Apertis and has limited
applicability to WebKit that replaced it. Remove it.

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

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

This document briefly describes an investigation that was carried out and
the results. This kind of information isn't suitable for the main Apertis
website, it's the kind of information that should be in phabricator.

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

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

There are two AppArmor documents that have been carried over from the wiki
which both have issues:

- docs/security/apparmor.md
  - Describes apparmor profiles that no longer seem to be a part of Apertis
  - User session has signinficantly changed, no longer primarily using
    X.org

- docs/security/apparmor/d-bus.md
  - Discusses patches that are either fully integrated into Apertis or
    upstream by now
  - Some of the debugging tips no longer work
  - Discusses possible solutions to a D-Bus issue rather than stating
    implemented solution

These pages provide very little and contain lots of out-of-date
information. Remove them.

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

The firewall document is out of date in many ways:

- The package is now pulled from Debian, not a modified Fedora one
- The iptables rules have been conciderably extended
- Disabling iptables as described does not work

As a result, there's very little information here worth keeping. As we have
a more architectural overview of filtering(1), drop this page.

1) https://designs.apertis.org/latest/security.html#network-filtering



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

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

Update the information regarding the progress of the changes upstream and
into Apertis. Move to architecture.

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

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

The virtual button infrastructure no longer seems to be a part of Apertis.
The screen calibration description still seems valid, so move this to its
own page under `guides/`.

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

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

The search mechanism documented here currently doesn't work:

user@apertis:~$ folks-inspect search foo

(folks-inspect:13376): folks-WARNING **: 01:48:07.385: backend-store.vala:434: Error preparing Backend 'telepathy': The name org.freedesktop.Telepathy.AccountManager was not provided by any .service files

This functionality is currently not a priority, drop the documentation
since it doesn't work.

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

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

The presentations page is missing any presentations since 2017. Update the
page with known presentations that have been given since then and move to
architecture as these are high level descriptions relating to Apertis.

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

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

The SQLite tests have been removed from the testing, remove the
documentation covering SQLite and move rest to architecture.

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

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

The guide on connman proxy setup is relevant, update the formatting, add a
little more info on how to check current config and move to guides.

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

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

This page is out of date. It says it's out of date and points to a newer
version in developer.a.o:

https://developer.apertis.org/apis.html



Since this one is dead, remove it.

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

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

The plymouth splash screen application is still being used, but the
GStreamer module written for Apertis is not currently enabled in the
package. As the patches for this support are still available comment out
the mentions of this functionality so they may be re-instated if the
support is added back. Move document to guides as it covers how to use and
modify plymouth.

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

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

The rollback-daemon has been replaced by OSTree, remove the page describing the
old method.

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

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

This page describes a partition layout that has been abandoned for quite
some time, remove it.

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

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

The tool described for traffic control, tcmmd, hasn't been available in
Apertis since before v2019. This page therefore describes functionality
which is no longer provided in Apertis, remove it.

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

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

The factory reset tool has being removed, with system update and rollback
strategy having been replaced by OSTree. This page describes functionality
which is no longer provided, remove it.

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

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

Document covers how to use OSTree, which is still relevant. Move it to the
guides section.

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

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

The weighting of the pages is used to order them on the site, with pages of
equal weight being sorted by date. The default weight in Hugo is 0, the lowest
weight. The virtualbox page currently doesn't specify a weight, this results in
the VirtualBox page being dropped to the bottom of the sorting even though it's
one of the newest pages.

Providing pages with our own default weight gives us the flexibility to demote
content in the future that we want to keep, but wish to have lower priority.
For now, give the VirtualBox page the same weighting as the other pages so that
it doesn't sink to the bottom.

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

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

There are 3 webkit related documents in the root folder:

- webruntime.md: Marked as WIP. Move to `concepts/` folder as this doesn't
  seem to have been completed.
- webkit2.md: Looks to be still relevant, move to `guides/`.
- webkit2_customizablewidget.md: Referenced by webkit2.md, move to
  `guides/`.

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

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

The privacy policy is out of date, we have a policy of giving 3 days notice
of changes to the privacy policy. Lets honor that by flagging it on the
website till the 1 July 2020, at which point we can inact the change.

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

Add Hugo shortcodes and CSS to Hugo theme to allow notice blocks to be
added to the markdown. There are 4 types available:

- warning
- info
- note
- tip

By adding the following hugo shortcode around some text a formatted box is
added to the HTML output:

    {{% notice info %}}
    Text for notice
    {{% /notice %}}

This will be useful for highlighting important information.

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

This patch fixes a minor typos that I missed during initial review.

Signed-off-by: Peter Senna Tschudin <peter.senna@collabora.com>

The resulting page has the title and the first section close together
which makes having the section name redundant. This patch removes the
section name.

Signed-off-by: Peter Senna Tschudin <peter.senna@collabora.com>

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

The roadmap currently visible on the website is out-of-date. Update the
roadmap based on the roadmap topics found on the Apertis workboard,
covering the 3 quarters of 2020 that have been planned. Move roadmap under
"policies/" which is probably the best fit for it.

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