Walter Lozano authored 4 years ago and Peter Senna Tschudin committed 4 years ago

Update documentation about Automated License Compliance based on the current
development status reflecting some of the decision that have been made.

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>

Described the switching between ostree branches (aka "upgrade
major version") during offline upgrades.

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

Currently if a sitebar item is a sub-section rather than a page, focus and
highlighting is not applied to the section heading. This is because the
current section is not the first level section, it's the sub-section.

Tweak the logic to compare first level sections.

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

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

Christopher Obbard authored 4 years ago and Frederic Danis committed 4 years ago

The debian 11 codename is "Bullseye", not "BullEye". Fix it.

Signed-off-by: Christopher Obbard <chris.obbard@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>

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

This documentation discusses how to download and modify a debian package
from OBS. Since we are using a gitlab based workflow these days, this
documentation is very miss-leading.

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

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

Missing word making sentence clunky. Fix it.

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>

Recently people have been asking which kernel version is shipped on our
releases, and pointing them to the pkglist of the images to find the
right stanza didn't seem great.

Let's make that bit of information explicit in the recent release notes.

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

Some of the licensing provided for the packages listed in the TLS stack
document aren't right - correct them.

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

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

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

There is little to no utility carrying the 2+ year old weekly test
reports. Newer test reports are now reported on:

   https://lavaphabbridge.apertis.org/



The reports add siginficant bloat to the website and therefore to the
search file. Remove the reports and clean up any links to them.

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

Starting version v2020.7 `libostree` upstream provides deltas with
[signed metadata](https://github.com/ostreedev/ostree/pull/1985

)
allowing to validate the creator of the delta file itself, not only
the commit inside.

Add information about affecting this upstream change to Apertis.

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

* Update the main page to point to the latest old-stable release
* Update the release schedule
* Update the data file

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

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

A decision by Debian to treat OpenSSL as a system library has come to
light, which had not come to light at the time the original document was
written. Update the document to reflect this decision.

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

Take into account that maintainers may take resposibility for a single
component.

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

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

A basic template has been formulated to aid with writing concept documents.
Add this to the contributions policy and checklist.

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

We are currently pointing to the images policy instead of the download
page from the "Download the current images" link on the home page,
redirect this to the download page now we have one as that's more
relevant.

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

The shortcode is missing the ability to create URLs to ostree images. This
is vital since the download page should be serving OSTree images!

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

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

Now we have a download page, point to that rather than the image site in
key places. Update the image page to de-emphasise the Apertis images site
a bit (and prioritise the OSTree images) a bit more.

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

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

The Apertis website currently points users to the images site for
downloading images. This site contains a lot of different images and
presents a daunting number of options for those not versed in Apertis
images (like new users).

Create a page on the Apertis website that provides a much easier way to get
the currently recommended (stable, ostree) images. Add links to images
using a shortcode to make the download page easier to update.

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

We use the ref shortcode extensively to limit the risk of broken links
between pages on the website. Document this requirement in the README.

Promote the PDF generation section whilst here as it's also relevant to anyone
writing documentation.

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 checklist currently covers only a very narrow subset of
possible submissions, primarily new Apertis specific code and APIs. This is no
longer a major part of what Apertis is providing and many of the requirements
do not reflect current practice.

Remove the existing checklist and provide a new one that covers points to be
covered for code, component and design submissions, breaking down when and
where responsibility lies during the development and submission process.

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

The "Submission Checklist" is confusingly stored in a file called
`contribution_checklist.md`. Rename the document "Contribution Checklist" to
match the name of the file and align it with the Contribution Process
document.

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

The platform APIs and services page is one of the older pages still
available on the site. As it isn't as important as it may once have been,
remove the direct link from the main page.

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

Beyond showing the user how to load and build a project with eclipse
(which is rather basic and will surely be covered in generic Eclipse
documentation), this document shows the user how to [un]install the
application using the now defunct Apertis plugin. Since this is no longer
available, delete this page.

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>

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

The Application Development page is thin on content and mainly covers
required knowledge for development using the deprecated Canterbury era
applications.

This is superfluous, remove it.

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

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

The hands free test is known to cause some issues with timeouts when
performed as part of the bluez-phone test suite against some phones. This
is not something for which there is a priority to fix, so mitigate the
risk of these timeouts by keeping the bluez-hfp tests separate for now.

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

The Apertis platform document is out of date. Update it to reflect some
changes to the Apertis project that have been true for a while:

- We use GitLab rather than straight git repositories
- All code is stored in GitLab (rather than as packages in OBS)
- We use GitLab for code review rather than Phabricator
- Automation has been moved from Jenkins to GitLab CI/CD
- We don't interact directly with OBS much any more
- We use OSTree for OTA updates

Also, remove the comparison with Yocto as this is neither overly balanced,
accurate nor useful.

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