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>

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>

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

A number of clarifications and changes have been requested as part of the
TLS-stack document review.

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>

Following discussions, tweak some of the recommendations from the test
case review.

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

Discuss challenges and approaches wrt. infrastructure maintenance.

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

It was agreed that dbus-dos-reply-time can be useful as a point of
comparison in certain cases. Keep this test for now.

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

The basic alias for https://www.apertis.org/old-developer/

 is missing and
thus redirection is ending up at the 404 page.

Add the missing alias.

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

This patch adds a contribution template for an ideal first email that
proposes a description for a design document and ask for help and ask
about suitability for the Apertis project.

Signed-off-by: Peter Senna Tschudin <peter.senna@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 contribution process document has some out of date sections, tweak
these to make it aligned to current expectations:

- Secure Boot document is now not a design document but an architectural
  document. Remove the reference as it's no longer helpful. Point to
  Concepts section instead.
- Designs is a section that's being removed. Point to Architecture and
  Guides for current implementations.
- We no longer tag releases manually, remove that as example of manual
  process.
- There's much less need for OBS accounts make this clearer.

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

Completing our release cycles on 22/Dec was deemed too risky, so here's
a revised schedule.

Putting it in another format:

2020-11-12 v2019.5   feature freeze
2020-11-13 v2020.3   feature freeze
2020-11-16 v2019.5   code freeze
2020-11-17 v2021pre  feature freeze
2020-11-19 v2019.5   RC1
2020-11-20 v2020.3   code freeze
2020-11-20 v2019.5   RC testing start
2020-11-23 v2021pre  code freeze
2020-11-25 v2022dev0 feature freeze
2020-11-26 v2019.5   RC testing end
2020-11-26 v2020.3   RC1
2020-11-27 v2019.5   release
2020-11-27 v2020.3   RC testing start
2020-12-02 v2020.3   RC testing end
2020-12-02 v2021pre  RC1
2020-12-02 v2022dev0 code freeze
2020-12-03 v2020.3   release
2020-12-03 v2021pre  RC testing start
2020-12-09 v2021pre  RC testing end
2020-12-09 v2022dev0 RC1
2020-12-10 v2021pre  release
2020-12-10 v2022dev0 RC testing start
2020-12-16 v2022dev0 RC testing end
2020-12-17 v2022dev0 release

The RC testing periods would then be:

2020-11-20..26    v2019.5
2020-11-27..12-02 v2020.3
2020-12-03..09    v2021pre
2020-12-10..16    v2022dev0

The releases:

2020-11-27 v2019.5
2020-12-03 v2020.3
2020-12-10 v2021pre
2020-12-17 v2022dev0

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

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

The "Debugging app in eclipse" document describes how to launch an
application in a simulator in debugging mode. The simulator is no longer
available in any supported version of Apertis, so remove this document.

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

The developer site has a fairly good platform guide that is much more
comprehensive than the "about" page on the main website. Remove the about
page in favour of the platform guide.

This page needs more updating. That will be done in a future commit.

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

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

We have multiple locations where the licensing of Apertis is explained.
Simplfy/merge these explanations.

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

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

Move the bundle spec to the architecture section, add more links from the
documentation to the spec.

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

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

The widget catalog presents no real advantage over looking at the API
reference docs. Remove the widget catalog.

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

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

The "API" and "SDK Technologies" pages from the developer site have a lot
of overlap. Merge these 2 pages together to provide a more comprehensive
list of services and APIS provided in Apertis.

Move the combined document to architecture.

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

Move the sysroots and devroots doc. Do a few minor edits to add formatting and
links in the images documentation pointing to this where sysroots and devroots
are briefly described.

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