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>

The titles in the supported virtualbox table are a bit messy. Clean them
up a bit.

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

A few issues were missed when reviewing the addition of a table of
supported virtualbox versions:

- There's an additional "{" on one of the shortcodes that's getting
  rendered in the final page.
- The table is missing a column marker and is thus not getting formatted
  as a table.

Fix these two issues.

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

Benani Sagar Kishore authored 4 years ago and Martyn Welch committed 4 years ago

officially supported by Apertis for each release.

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

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>

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

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>

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>

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>

The virtual machine guidance is scattered over 3 pages, is poorly formatted
and a little out of date.

Check, update and merge the pages to make it more concise and relevant.
Move to it's proper location under `guides`.

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