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

The versioning information doesn't sit very well in the releasing
packages guide. Add this to the information on binary package
versioning to make a more holistic page on versioning.

Move the information on dch tags to the version_control guide where
it is mentioned.

The rest of this guide is very out of date. We have a number of other
guides on releasing packages, drop this one.

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

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

More of the guides still seem relevant and good information. Tweak the
formatting and move these to guides.

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

* Reorder each example under each chunk
* Indent the examples so that they are rendered proper in hugo

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

* Cleanup paragraph
* Add date and weight field
* Use reference shortcodes
* Strip shell prompt

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

Moved from ci-package-builder

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

That every rebuild repository should have the following meta attribute
set because otherwise, packages would run into a cyclic build loop.

 rebuild="local" block="never"

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

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

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

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

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

Instead of ``` triple quote ticks, which treats the text as code example

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

Moved from repository apertis-infrastructure

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

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

Move the doc on module setup, broadly unchanged (minor formatting
improvements).

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

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

The introduction to the linters guide is rather thin. Improve it 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

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

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

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>

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>

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>

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

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>