- May 04, 2021
-
-
The Apertis packaging toolchain and pipelines have switched from the `coX` packaging version suffix to `apertisX` to better distinguish the work of the Apertis team from more Collabora-specific packages. Signed-off-by:
Emanuele Aina <emanuele.aina@collabora.com>
-
- Apr 29, 2021
-
-
Arnaud Ferraris authored
This commit enables the generation and display of the ToC on all pages where it's relevant due to the content size. More pages could have been included but left aside due to inconsistent use of heading levels leading to rendering/visual glitches. The pages' content has not been modified, except for the "Terms of use" page which included a manually-generated ToC. Signed-off-by:
Arnaud Ferraris <arnaud.ferraris@collabora.com>
-
- Apr 26, 2021
-
-
Walter Lozano authored
Improve documentation by providing an example of debos overlay action to apply customizations to images. Signed-off-by:
Walter Lozano <walter.lozano@collabora.com>
-
- Mar 29, 2021
-
-
Now we have an implemented a status page, add details about this to the infrastructure monitoring document. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Feb 23, 2021
-
-
Signed-off-by:
Andrej Shadura <andrew.shadura@collabora.co.uk>
-
- Feb 16, 2021
-
-
Walter Lozano authored
Add to the platform document and introduction to the image generation about debos and the versatility it provides to build customized images. Signed-off-by:
Walter Lozano <walter.lozano@collabora.com>
-
- Feb 03, 2021
-
-
The long term reproducibility document doesn't utilise the formatting available in Hugo overly well and contains a number of uses of UK English and terms that aren't widely used. Tweak the document to use US spelling and more common terms. Make use of Hugo formatting capabilities where sensible. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The software distribution and updates document covers attributes of the distribution and update process that are not yet fully present in Apertis. It is therefore much more suited to the concepts section of the documentation. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jan 24, 2021
-
-
Whilst reworking the glossary, a number of layout improvements and broken links were identified in the documents which the glossary point to. Fix these minor issues. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jan 22, 2021
-
-
Martyn Welch authored
These documents appear to be concepts that are still open (though some quite stale). Move them to concepts to get the designs section removed soon. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Dec 22, 2020
-
-
Target devices with limited computing power(such as a single core, or just a little bit of RAM) may fail or need a long time to open encrypted files that were not created for small devices. This patch adds documentation that explain how to create encrypted files that are suitable for small devices. Signed-off-by:
Frédéric Danis <frederic.danis@collabora.com>
-
- Nov 18, 2020
-
-
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>
-
- Nov 17, 2020
-
-
Martyn Welch authored
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>
-
Martyn Welch authored
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>
-
- Nov 16, 2020
-
-
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>
-
- Nov 11, 2020
-
-
Martyn Welch authored
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>
-
- Nov 02, 2020
-
-
Emanuele Aina authored
Discuss challenges and approaches wrt. infrastructure maintenance. Signed-off-by:
Emanuele Aina <emanuele.aina@collabora.com>
-
- Oct 22, 2020
-
-
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>
-
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>
-
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>
-
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>
-
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>
-
- Oct 19, 2020
-
-
Martyn Welch authored
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>
-
- Oct 15, 2020
-
-
Peter Senna Tschudin authored
This commit fixes typos and small issues on the long term reproducibility document. Signed-off-by:
Peter Senna Tschudin <peter.senna@collabora.com>
-
- Oct 13, 2020
-
-
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>
-
- Oct 02, 2020
-
-
Emanuele Aina authored
Update the document to reflect the latest implementation status. Signed-off-by:
Emanuele Aina <emanuele.aina@collabora.com>
-
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>
-
- Sep 23, 2020
-
-
This document describes how we built images on Jenkins, but we have now largely moved away from it in favor of GitLab CI/CD. The README in the infrastructure/apertis-image-recipes> project describes the current setup closer to the actual code. Keep the document around since v2019 and v2020 are still officially on Jenkins and old release notes still point here. Signed-off-by:
Emanuele Aina <emanuele.aina@collabora.com>
-
- Sep 22, 2020
-
-
The selection of images as defined for the v2019 release has been used for a number of releases. This is no longer an open concept, add the documentation to the images page and remove the concept document. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Sep 03, 2020
-
-
The design documents imported from designs.apertis.org need to be classified and moved into the structure implemented for documents on the new website. The content of the documents also need minor edits to ensure a good look and feel as well as the addition of notes to explain the context of some documents (such as noting that certain concept documents have been implemented since they were written and when that occurred). This commit contains conversion of an initial batch of design documents. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jul 29, 2020
-
-
After moving the documents from designs.a.o to www.a.o, there were quite a few links from the designs.a.o docs pointing to wiki.a.o and quite a few links from www.a.o pointing to designs.a.o. Replace these links with Hugo ref shortcodes to avoid hammering the redirects. This was achieved with the following script: ``` import os import re import sys import toml from urllib.parse import urlparse def get_aliases(filename): #print("%s: " % filename) with open(filename, 'r') as file: contents = file.read() if not contents[0:3] == "+++": return if "_index.md" in filename: filename = filename.strip(".") else: filename = filename.split("/")[-1] data = toml.loads(contents.split("+++")[1]) if not "aliases" in data.keys(): return for alias in data["aliases"]: if "/old-wiki/" in alias: wiki_aliases[alias.replace("/old-wiki/", "/")] = filename if "/old-designs/" in alias: # We're dropping the per-release links from designs.a.o, so match on shorter path design_aliases[alias.replace("/old-designs/latest/", "/")] = filename def fix_link(url): link = url.group('link') url = urlparse(link) if url.netloc == "wiki.apertis.org": if url.path in wiki_aliases.keys(): url = url._replace(scheme="") url = url._replace(netloc="") url = url._replace(path=wiki_aliases[url.path]) link = " {{< ref \"%s\" >}} " % url.geturl() if url.netloc == "designs.apertis.org": # We're dropping the per-release links from designs.a.o, so match on shorter path path = "/%s" % url.path.split('/', 2)[-1] print(path) if path in design_aliases.keys(): url = url._replace(scheme="") url = url._replace(netloc="") url = url._replace(path=design_aliases[path]) link = " {{< ref \"%s\" >}} " % url.geturl() return "](%s)" % link def fix_ref(url): link = url.group('link') url = urlparse(link) if url.netloc == "wiki.apertis.org": if url.path in wiki_aliases.keys(): url = url._replace(scheme="") url = url._replace(netloc="") url = url._replace(path=wiki_aliases[url.path]) link = " {{< ref \"%s\" >}} " % url.geturl() if url.netloc == "designs.apertis.org": # We're dropping the per-release links from designs.a.o, so match on shorter path path = "/%s" % url.path.split('/', 2)[-1] print(path) if path in design_aliases.keys(): url = url._replace(scheme="") url = url._replace(netloc="") url = url._replace(path=design_aliases[path]) link = " {{< ref \"%s\" >}} " % url.geturl() return "]: %s" % link def correct_links(filename): #print("%s: " % filename) with open(filename, 'r+') as file: contents = file.read() if not contents[0:3] == "+++": return fm = contents.split("+++")[1] doc = contents.split("+++",2)[2] # Hotdoc allows empty links like `[](url)` pattern = re.compile("\]\((?P<link>.*?)\)") doc = pattern.sub(fix_link, doc) pattern = re.compile("\]: (?P<link>.*)") doc = pattern.sub(fix_ref, doc) file.seek(0) file.truncate() file.write("+++") file.write(fm) file.write("+++") file.write(doc) wiki_aliases = {} design_aliases = {} for root, dirs, files in os.walk(sys.argv[1]): for file in files: if ".md" in file: get_aliases("%s/%s" %(root, file)) print("wiki_aliases:") print(wiki_aliases) print("design_aliases:") print(design_aliases) for root, dirs, files in os.walk(sys.argv[1]): for file in files: if ".md" in file: correct_links("%s/%s" %(root, file)) ``` Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jul 24, 2020
-
-
We have very little documentation regarding the handling of Debian revisions but we need to update these more frequently than raw version numbers. Pull some documentation from a training session guide written a while back to fill this hole. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The versioning information doesn't sit very well in the releasing packages guide. Add this to the information on binary package versioning to make a more holistic page on versioning. Move the information on dch tags to the version_control guide where it is mentioned. The rest of this guide is very out of date. We have a number of other guides on releasing packages, drop this one. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
These documents are higher level than a guide, move to architecture. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jul 13, 2020
-
-
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>
-
- Jun 30, 2020
-
-
Update the information regarding the progress of the changes upstream and into Apertis. Move to architecture. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The presentations page is missing any presentations since 2017. Update the page with known presentations that have been given since then and move to architecture as these are high level descriptions relating to Apertis. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The SQLite tests have been removed from the testing, remove the documentation covering SQLite and move rest to architecture. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The plymouth splash screen application is still being used, but the GStreamer module written for Apertis is not currently enabled in the package. As the patches for this support are still available comment out the mentions of this functionality so they may be re-instated if the support is added back. Move document to guides as it covers how to use and modify plymouth. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- May 28, 2020
-
-
The system startup document is out of date. Provide a brief updated description of the Apertis boot process and move to a new "architecture" section. Split out the boot analysis into its own document and move to a new "guides" section. Remove the previously performed optimisations as these describe patched in changes that no longer appear to be a part of Apertis. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-