- Oct 22, 2020
-
-
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>
-
- Oct 19, 2020
-
-
Martyn Welch authored
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>
-
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 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 12, 2020
-
-
Ritesh Raj Sarraf authored
.gitattributes is used by many projects in their development workflows. THis can, many a times, interfere with the Apertis package development workflow. Thus document the fix for such cases. Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
The base-files package, depending on its branch name, generates the os distribution specific attributes. Since those attributes expect a certain set of infrastructure changes available (eg. new release's docker images), this step is classified to be executed manually. Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
- Oct 02, 2020
-
-
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 24, 2020
-
-
Ritesh Raj Sarraf authored
This documents the invocation of the automation script for folding changes. And also emphasizes that the final result should be validated manually. Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
- Aug 03, 2020
-
-
Ritesh Raj Sarraf authored
This is required when the cleaning up and recovering space. Usually, the beta, development and preview releases are the common candidates for removal Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@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 27, 2020
-
-
Ritesh Raj Sarraf authored
This file is used throughout our Apertis packaging repositories by all packages. It specifies which repository component a package is part of Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
Document the process for updating packages where we pull from an upstream (non-Debian) source, such as we do for the LTS v.5.4 kernel. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jul 24, 2020
-
-
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>
-
More of the guides still seem relevant and good information. Tweak the formatting and move these to guides. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
Ritesh Raj Sarraf authored
* Reorder each example under each chunk * Indent the examples so that they are rendered proper in hugo Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
Ritesh Raj Sarraf authored
* Cleanup paragraph * Add date and weight field * Use reference shortcodes * Strip shell prompt Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
- Jul 19, 2020
-
-
Ritesh Raj Sarraf authored
Moved from ci-package-builder Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
- Jul 15, 2020
-
-
Ritesh Raj Sarraf authored
That every rebuild repository should have the following meta attribute set because otherwise, packages would run into a cyclic build loop. rebuild="local" block="never" Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
Ritesh Raj Sarraf authored
Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
Ritesh Raj Sarraf authored
Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
Ritesh Raj Sarraf authored
Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
Ritesh Raj Sarraf authored
Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
Ritesh Raj Sarraf authored
Instead of ``` triple quote ticks, which treats the text as code example Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
- Jul 14, 2020
-
-
Ritesh Raj Sarraf authored
Moved from repository apertis-infrastructure Signed-off-by:
Ritesh Raj Sarraf <ritesh.sarraf@collabora.com>
-
- Jul 13, 2020
-
-
Move the doc on module setup, broadly unchanged (minor formatting improvements). Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The introduction to the linters guide is rather thin. Improve it and move to `guides/`. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
These documents can be moved to guides more or less as they are. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The version control guide looks useful, but is a little out of date. Update the guide to use current workflows and move to `guides/`. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The following guides can be moved to `guides/` with minimal changes: - buildingpatchingandmaintainingtheapertiskernel.md - gitlab-based_packaging_workflow.md - howtobuildyourownkernel.md - howtodevelopondevices.md - logging.md Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jun 30, 2020
-
-
The virtual button infrastructure no longer seems to be a part of Apertis. The screen calibration description still seems valid, so move this to its own page under `guides/`. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The guide on connman proxy setup is relevant, update the formatting, add a little more info on how to check current config and move to guides. 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>
-
The rollback-daemon has been replaced by OSTree, remove the page describing the old method. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The factory reset tool has being removed, with system update and rollback strategy having been replaced by OSTree. This page describes functionality which is no longer provided, remove it. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
Document covers how to use OSTree, which is still relevant. Move it to the guides section. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
The weighting of the pages is used to order them on the site, with pages of equal weight being sorted by date. The default weight in Hugo is 0, the lowest weight. The virtualbox page currently doesn't specify a weight, this results in the VirtualBox page being dropped to the bottom of the sorting even though it's one of the newest pages. Providing pages with our own default weight gives us the flexibility to demote content in the future that we want to keep, but wish to have lower priority. For now, give the VirtualBox page the same weighting as the other pages so that it doesn't sink to the bottom. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
There are 3 webkit related documents in the root folder: - webruntime.md: Marked as WIP. Move to `concepts/` folder as this doesn't seem to have been completed. - webkit2.md: Looks to be still relevant, move to `guides/`. - webkit2_customizablewidget.md: Referenced by webkit2.md, move to `guides/`. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jun 17, 2020
-
-
Martyn Welch authored
The SDK page is a mess, rather than describing the SDK, it provides some examples of how to use the (legacy) Canterbury Application Framework. - Move this page to `ade.md` rather than `sdk.md` - Update ade example as it's broken (we can use the actually tested workflow) - Remove the documention describing the Apertis Eclipse Plugin. This doesn't seem to have been available since before v2019, so is effectively unsupported at this point. - Update references to the SDK page to point to the best description of the SDK we currently seem to have on designs.a.o for now. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
- Jun 16, 2020
-
-
Martyn Welch authored
Move guides from the base directory into the guides/ sub directory to provide better organisation of the documents on the website. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-
Martyn Welch authored
Information about the reference hardware and supported platforms is a bit jumbled and out of date. Split out the listing of reference hardware by architecture to avoid having one massive long page. Shift out development related details. Signed-off-by:
Martyn Welch <martyn.welch@collabora.com>
-