Signed-off-by: Ariel D'Alessandro <ariel.dalessandro@collabora.com>

Martyn Welch authored 3 years ago and Martyn Welch committed 3 years ago

Apertis now has open registration on it's GitLab instance. Update the
documentation to reflect this.

Correct some spelling mistakes and grammatical issues noticed when reading
documents.

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

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

We are updating the privacy policy and terms of use as part of opening up
GitLab. Add these to the website and provide a page covering the need for
the change and providing links to the new and old documents.

Add a banner to the home page highlighting this change. We will need to
give 30 days notice before fully affecting the change as it's stated we
will do that in the existing privacy policy.

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>

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

The release flow and product lines document has been moved from designs to
policies, however we have some links to this document in places that are
really not possible to change. Add an alias to forward from the old address.

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

Version 4.0 of the CC BY-SA license was written in a way that didn't
require to be ported to different legal jurisidictions, thus it is
correctly known as the "Creative Commons Attribution-ShareAlike 4.0
International License" not the "Creative Commons
Attribution-ShareAlike 4.0 Unported License".

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>

We are not keeping the roadmap page up to date, it is currently about a
year behind where it should be with the latest information covering Q3 of
2020. If we are not going to keep it up-to-date, lets get rid of it rather
than present clearly out-of-date information on the website.

The links from all release notes that point to the page are also removed
by this commit, but the text is retained to minimise change to these
historic documents. The text and link has been removed completely from
release schedules.

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

Point to some nice guidelines to organize the control flow, regardless
of the programming language.

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

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

Whilst we call out specific policies in the contribution checklist, we
should make sure that any contributions made to Apertis do not violate any
of Apertis' policies. Explicitly add this to the contribution checklist.

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

The new Debos backend autodetection was misreported as part of v2021pre
but has not been actually landed there while it is part of v2022dev0.

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

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

We state that authors of submissions to extend existing components could
be asked to submit the change upstream, however we do not cover the option
of using a dedicated project area for tweaked components should changes
not be of general applicability to Apertis.

Highlight that dedicated project areas may be made available for this
purpose.

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

Signed-off-by: Emanuele Aina <emanuele.aina@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 Martyn Welch committed 4 years ago

Signed-off-by: Emanuele Aina <emanuele.aina@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>

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>

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>

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>

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>

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>

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

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 Emanuele Aina committed 4 years ago

The developer documentation contains URLs to designs.a.o and the old wiki.
The website contains links to the developer site. Now that these are all
on the same site, update links to internal links.

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

For external developers, they may not have access right to push branches
into default repositories. We encourage users to fork the repository and
then prepare a merge request.

So updating the documentation accordingly.

Signed-off-by: Ritesh Raj Sarraf <ritesh.sarraf@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>

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

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

Add a basic description to the index page for each of the "official"
sections (as laid out inthe websites README.md). This provides visitors to
the site with some guidance as to what to expect to find in each section,
somewhere to point out to related polices (such as the release schedule and
flow from the releases section) and a way to add aliases (such as the
missing alias to Guides for the "Guidelines" section that was found on the
old wiki).

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

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