Elvstam Cantner Andreas authored 4 years ago and Martyn Welch committed 4 years ago

Change from localhost to proper link address for /policies/upstreaming
referenced from apparmor.md

Signed-off-by: Andreas Elvstam Cantner <andreas.elvstam@se.bosch.com>

Update some broken links by pointing them to the new location of the
ci-package-builder documentation.

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

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

Since we moved to an external CI config path branches like
`debian/buster-gitlab-update-job` are no  longer needed.

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

We no longer use the `debian/apertis/gitlab-ci.yml` files in each
packaging repository but rather rely on a external CI config path.

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

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

Andrej Shadura authored 4 years ago and Emanuele Aina committed 4 years ago

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Andrej Shadura authored 4 years ago and Emanuele Aina committed 4 years ago

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Andrej Shadura authored 4 years ago and Emanuele Aina committed 4 years ago

The diagram comes in two formats:
 - SVG with editable text (apertis-dep-14-gitlab.svg)
   This is the primary source.
 - SVG with texts as paths (apertis-dep-14-gitlab-curves.svg)
   This is generated from the primary source; it is a preferred
   format for embedding as a figure in a document, since it
   doesn’t depend on the availability of fonts or the renderer’s
   ability to render them correctly.

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Since we are editing the development process, use this an an
opportunity to improve the spelling in the document and the website's
custom dictionary.

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

The development process states that a "Fixes: APERTIS-<task_id>" tag
should be added to relevant commit messages. At some point we had
functionality in place to automatically add comments on the Phabricator
task when such tags were present. I don't believe that this
functionality is still in place, hence the description is missleading.

This is also not something that I have seen being used (a lot?) by core
maintainers. Since this is not common practice we should remove this
requirement, simplifying the documented process for new contributors.

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

Thank you @andrewsh for spotting it.

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

The titles in the supported virtualbox table are a bit messy. Clean them
up a bit.

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

A few issues were missed when reviewing the addition of a table of
supported virtualbox versions:

- There's an additional "{" on one of the shortcodes that's getting
  rendered in the final page.
- The table is missing a column marker and is thus not getting formatted
  as a table.

Fix these two issues.

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

Benani Sagar Kishore authored 4 years ago and Martyn Welch committed 4 years ago

officially supported by Apertis for each release.

Fix some formatting issues, remarks and command names.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

Walter Lozano authored 4 years ago and Martyn Welch committed 4 years ago

As currently the infrastructure repository uses only a master branch update
the links accordingly.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

As a reference for the installation of Automated License Compliance add a
guide to pointing to the pieces of software to be installed and upgraded.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

When a new release is branched, we need to ensure that a proper rotation
job is set for the respective release. In this example, we instantiate a
new timer for rotation of the images

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

For most major task, our user account suffice on OBS. But there are
certain exceptions, like creating new repositories, wherein we need
Admin level privileges.

This is required when we create new repositories for a stable release:
security, updates, backports.

Document this oddity that the user needs to have Admin level privileges

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

Martyn Welch authored 4 years ago and Frederic Danis committed 4 years ago

Merge the useful bits of the "wip" AppArmor documentation into the main
AppArmor document.

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

Emanuele Aina authored 4 years ago and Frederic Danis committed 4 years ago

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

Emanuele Aina authored 4 years ago and Frederic Danis committed 4 years ago

The "How to Make Your Code Reviewer Fall in Love with You" post provide
a nice and entertaining guide on submitting changes for review.

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

The Apertis documentation refers to the role of maintainer in a number of
places, but never defines what the role entails. Add a section to cover
this role, linking to it from places where it is relevant.

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

The "contribution process" as much details Apertis' policies with regards
to contributions as laying out a process. Rename the page to simply
"contributions" to make the scope of the document a bit clearer.

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

The contribution process document contains both policy information as well
as more of a development guide. Split the development guide section out as
it's own document in guides rather than having it contained in the policy
document.

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

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

Move the last of the developer documents to sensible locations, adding
warnings where documents are clearly based on the legacy Canterbury
framework.

Remove the link to the developer section from the main page since it no
longer exists.

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

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

We have two documents describing how to use ADE, merge them.

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

Add a paragraph to enforce the release early, release often philosophy
to give better context about the number of MR to include in a release
commit.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

Walter Lozano authored 4 years ago and Emanuele Aina committed 4 years ago

Based on the example previously presented update the gitlab-rulez example

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

Walter Lozano authored 4 years ago and Emanuele Aina committed 4 years ago

Fix the commit message example showing the correct path for the
file changed.

Signed-off-by: Walter Lozano <walter.lozano@collabora.com>

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

The persistent workspace documentation is currently in the SDK usage document.
The usage document covers some very basic usage, whilst the persistent
workspace is a little bit more of an advanced topic. Split it out into its own
document and move both to guides.

Additionally the design document is still present for the persistent workspace
feature. This is now redundant since the design has been implemented. Move the
limited amount of pertanent information from the design document to the guide
and remove the design 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

We are rapidly removing the developer section, remove the index that is
broadly covered elsewhere. The FAQ is also either covered elsewhere or
completely out of date. The programming guides have been moved to the main
guide section and thus this is now pointless.

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

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

The deployment guide is becomming a bit out-of-date, tweak to improve
readability and update the out-dated sections. Sort in to the new layout
under guides.

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

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

Move pstore guide, lightly edit to improve formatting.

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

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

Move the cross toolchain documentation to guides, doing some light editing
to make the advise more consistent.

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

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

The network development document is incomplete, missing out instructions
for setting up NFS and TFTP:

- Add these sections
- Lightly rework the document to improve wording and layout
- Move to guides section

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

The VirtualBox documentation from developer.apertis.org broadly covers the
same topics as the VirtualBox documentation the already existed on the main
website. Merge these together. Topics not closely tied to VirtualBox have
been moved to other pieces of documentation where they are better suited.

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

The developer documentation contains a number of documents that are
duplicated from the wiki. Remove the duplications, ensuring the remaining
copies are up-to-date.

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

Martyn Welch authored 4 years ago and Peter Senna Tschudin committed 4 years ago

Move documents out of designs and into more suitable locations following
the layout guidelines.

Perform some minor edits to correct typos and remove unneeded titles.

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