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>

This page describes a workflow utilising a simulator in the SDK to allow
the HMI to be run as if on a device for development. Based on the
description provided, it seems that the simulator was removed from the
16.03 release due to licensing issues. Additionally the description
describes a "Mildenhall plugin for Eclipse", which I suspect was a part of
the "apertis-eclipse-plugins", which haven't been available since before
v2019.

As this information is wildly out of date and doesn't seem to be supported
any longer, delete it as it's miss-leading.

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

We have a page which provides a workflow for writing documentation in
Mallard. Whilst we provide existing, mainly Gnome documentation that is
written in Mallard on the SDK, we do not appear to have written any
documentation ourselves in this format.

This information isn't really relevant to Apertis, get rid of it.

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

The SDK page is a mess, rather than describing the SDK, it provides some
examples of how to use the (legacy) Canterbury Application Framework.

- Move this page to `ade.md` rather than `sdk.md`
- Update ade example as it's broken (we can use the actually tested
  workflow)
- Remove the documention describing the Apertis Eclipse Plugin. This
  doesn't seem to have been available since before v2019, so is
  effectively unsupported at this point.
- Update references to the SDK page to point to the best description of
  the SDK we currently seem to have on designs.a.o for now.

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

Update the images and package maintenance pages and move them to polices.

The licensing section on the images pages is out of place. The process for
package management has changed now that we have everything in gitlab. We
no longer need a "MAINTAINED_IN_GIT.txt" file and the "third-party"
repositories have become redundant.

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

The website currently has a page of "requirements" for Newport, the
download manager. This page lists a number of recommendations for
requirements were drawn up after the initial implementation and review of
Newport. Looking at the commit history for Newport, it seems that these
requirements have never been implemented. Newport is not widely used and
is part of the legacy application framework and thus isn't receiving any
development effort.

As this page doesn't reflect the reality of what's available or likely to be
available in Apertis, delete it.

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

Move guides from the base directory into the guides/ sub directory to
provide better organisation of the documents on the website.

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

We have a number of URLs on the website that point to the old wiki. Since
these documents have either moved or we can provide a more direct link,
update the URLs. This will improve our ability to check for broken links.

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

Information about the reference hardware and supported platforms is a bit
jumbled and out of date. Split out the listing of reference hardware by
architecture to avoid having one massive long page. Shift out development
related details.

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

The containers page covers a proof-of-concept implementation of an
OSTree-based LXC container. This work became redundant, with the required
support being removed:

infrastructure/apertis-image-recipes@eb3c133f



As this is no longer viable, remove the page.

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

The touchscreen we currently use is the one shown in the i.MX6 SABRE
Lite picture, the HannStar HSD100PXN1-A00-C11.

It's not currently in stock. The Boundary Devices websites lists a few
more touchscreens, but we haven't validated them and to support them
some U-Boot changes would be needed to tweak the DTB on boot.

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

The virtual machine guidance is scattered over 3 pages, is poorly formatted
and a little out of date.

Check, update and merge the pages to make it more concise and relevant.
Move to it's proper location under `guides`.

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

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

Most of the docs are under the "docs" directory. Whilst the "docs" still
need to be sorted into the new categories, by moving the remaining
document not in this directory into it and patching up links, we can
remove the documentation page. Hugo automatically creates an index page
for us, so this simplifies the website a little with no real loss.

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

We plan to move the concepts from designs.a.o to the website. To lay the
foundations for this move, move documentation that was on the old wiki and
referenced from designs.a.o into `concepts/`. As these were referenced by
the designs, take them to be of equal importance to that information.

Add an index page that briefly describes what the concepts constitute,
basically topics that have been researched but not necessarily
implemented. Fix up any links that pointed to the location of the old
"concept designs".

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

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

In order to ensure a consistent look to the site, always use the same css
for page headings, don't require each section to define it's own css.

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

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

Start organising the documents on the website. Move documents that are
concerned with Apertis policies (one way or another) into a "policies"
section and link to this 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

Phabricator is a locked resource, only accessible by Collabora and Bosch
employees at this point. Remove this from the community page as it's not
accessible by those most likely to be reading this page.

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

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

These bugs are not accessible by the general public, remove the link from
the Apertis documentation.

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

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

The system startup document is out of date. Provide a brief updated
description of the Apertis boot process and move to a new "architecture"
section. Split out the boot analysis into its own document and move to a
new "guides" section. Remove the previously performed optimisations as
these describe patched in changes that no longer appear to be a part
of Apertis.

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