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

The consistency of spelling on the Apertis website isn't great. We use UK
English in places and US English in others. This could get problematic
when users are looking for documents describing artifacts when we've spelt
it "artefacts" in some relevant documents.

Let's start the process by documenting the use of the Aspell spell
checker. Start building a custom dictionary of acceptable terms, with the
plan of integrating this into the CI/CD process at some point in the
future.

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

We use the ref shortcode extensively to limit the risk of broken links
between pages on the website. Document this requirement in the README.

Promote the PDF generation section whilst here as it's also relevant to anyone
writing documentation.

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

Martyn Welch authored 4 years ago and Peter Senna Tschudin committed 4 years ago

Add the expectations for the utilisation of the various existing sections
to the website README.md to help guide contributors.

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

The README.md is currently the stock one added by the gitlab Hugo
template. Make the README.md more relevant for the Apertis website and
provide some information on how to cause PDFs to be generated.

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