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

These documents are higher level than a guide, 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

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>

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

We are now using the gitlab-based package workflow, the guidance on the
git-based package workflow page is out of date:

- We don't use the master branch
- We don't need the `MAINTAINED_IN_GIT.txt` file
- We no longer automatically close tasks based on tags
- We're not using Jenkins for package CI
- We don't submit packages to OBS manually

Delete the page.

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

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>

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>

This allows to create branches in `origin` based on new distributions.
Help to avoid issues:
  $ git push origin origin/upstream/${UPSTREAM_BASE}:upstream/${UPSTREAM_DISTRIBUTION}
  error: unable to push to unqualified destination: upstream/bullseye

Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>

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

This page was written prior to the Apertis project using gitlab. The
content it contains is either replicated in the the contribution
documentation or describes defunct processes that would be unavailable to
the average reader of the website (due to no access to Phabricator) even if
they were still true.

Remove this document to avoid confusion.

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

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

Google Code is no more. Update the link to a copy of the style guide else
where.

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

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

The phabricator workflow is not approriate for consumption by those not
inside Bosch or Collabora. The phabricator instance is password protected
and not accessible by the general public. Portions of this workflow also
do not make any sense outside a client relationship.

Move this content to the phabricator wiki where it is more relevant.

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

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

The Hugo Front Matter contains the title for each page, it is therefore
unnecessary to include a title as the first line in the markdown. Remove
the redundant titles to clean up page presentation.

Additionally we have a number of pages that have an initial title
"introduction", "intro" or similar. These are redundant so remove them too.

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

Many of the document titles contain directory names and/or are missing
spacing between words. This has a number of effects:

- It gives users a bad impression of the quality of the information on the
  website
- It makes it harder for external search engines to catalog the contents
  of the website in a meaningful way
- Reduces the effectiveness of any local searching that we implement

Do an initial quick pass on the titles to make them more legible.

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

The contribution process on designs.apertis.org currently has a section on
API review. This process doesn't fit with the focus of that document
(namely upstream contributions), so move it to the API documentation.

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

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

We have lots of duplicated and out-of-date information on various Apertis
sites. Remove the out-of-date information from the website for now and
point at the ci-package-builder documentation.

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

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

The docker image requires the path used during pull to be provided as part
of the image name else the following error is received:

Unable to find image 'apertis-v2021dev1-package-source-builder:latest' locally
docker: Error response from daemon: pull access denied for apertis-v2021dev1-package-source-builder, repository does not exist or may require 'docker login': denied: requested access to the resource is denied.
See 'docker run --help'.

Update the documentation to use the correct command.

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

The wiki markup made it so that fragment links needed to be named as per
the link name, thus enforcing the link test for such URLs started with a
hash. As we are not using a wiki anymore, this is not the case and we can
clean out the hashes to make the text more readable.

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

There are a number of badly formatted links that don't point correctly to
resources or point to resources that aren't available. Where possible
correct the links, if this is not possible remove or neuter the link to
preserve as much as possible.

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

A number of files in the `content/` directory are either unlinked (and
therefore hidden) or would have contained a message (generated by a wiki
template) stating they were obsolete and pointing to the updated location.

 - Move the unlinked documents into guidelines so that they are at least
   accessible via the automatic list, link if a quick location can be
   found.
 - Remove the obsolete pages and update the links to point to the correct
   location.

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

Move guidelines.md to be index for guilelines directory.

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

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

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

The conversion to markdown broke the <code> snippets.

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

The wiki had a wiki specific mechanism for redirecting pages. This doesn't
work outside of the wiki, so replace references to redirect pages as
appropriate and remove redirect pages. Ensure links from the old wiki are
maintained.

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

The wiki is now locked and a final dump of data performed. Update the site
to reflect these latest changes, including adding back a piece of ascii
art removed in the last dump as it was confusing the conversion tool.

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

So as to transition relatively seemlessly to the new site, we can use the
Hugo Alias functionality to put a number of HTML redirects in place to
translate between `/old-wiki/<original_link>` and the new page location.

We are hoping to combine this with URL rewriting on wiki.apertis.org to
redirect requests for pages formerly served there into the redirect
structure.

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

The "fragment" key is a key specific to the syna theme that we aren't
likely to be using. Remove it from the markdown.

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

The conversion script has been improved to handle links better. This
commit updates the content to the latest conversion.

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

Add latest scripted conversion of wiki pages and move to simple
Hugo theme.

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