diff options
author | s-makin <sally.makin@canonical.com> | 2023-01-10 19:06:30 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-10 12:06:30 -0700 |
commit | eb22a2426d4df1d1870dbef04f5edf7f58356ee1 (patch) | |
tree | dccd36968f27d60f08c4dc023e7950fc7af75a6f /cloudinit/config | |
parent | cb128dc1b76bf0a48783ecb815e02ecbc0f1a41f (diff) | |
download | cloud-init-git-eb22a2426d4df1d1870dbef04f5edf7f58356ee1.tar.gz |
docs: Diataxis overhaul (#1933)
Diataxis overhaul and style review
Introduces the Diataxis[1] framework including:
- Created Diataxis folders
- Moved all content to correct folders
- Updated index page with Diataxis sections
- Brought LHS nav bar into line with Diataxis
- Brought all docs in line with Ubuntu style guide
Additional minor/housekeeping changes:
- Added anchor tags/updated others
- Moved how-to content out of FAQ page (created new pages)
- Decorated various elements with tags (see below)
- Acronyms capitalised (and expanded on first showing if poss)
- All headings now sentence case
- Styling on all pages now self-consistent with each other
- Some minor edits to language, mostly for clarity
- Lists presented with headings in boldface changed to subheadings
- (to make use of RHS navigation bar for user convenience)
I also addressed inconsistencies in formatting and language.
I'm aware that some of these changes may need to be reverted or
changed to something else, so if I've made any errors in
judgement through lack of knowledge, please lmk (or if there are
overdue changes you want to make now while I'm doing it).
I have decorated files/paths with the :file: rST tag, obvious commands
with :command:, keyboard shortcuts with :kbd: and references to UI
elements with :guilabel: - the default styling may not be ideal,
but with the tags in place it can be edited en-masse through the
style files so the text elements display as expected.
There is an :abbr: tag that theoretically works like the hoverxref
package, but the default styling makes it hard to read the text so
I have not used it. There are similar tags for Python elements but
I haven't used them either, due to unfamiliarity with the base code.
[1] https://diataxis.fr/
Diffstat (limited to 'cloudinit/config')
-rw-r--r-- | cloudinit/config/cc_runcmd.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/cloudinit/config/cc_runcmd.py b/cloudinit/config/cc_runcmd.py index 464198c4..27c0429b 100644 --- a/cloudinit/config/cc_runcmd.py +++ b/cloudinit/config/cc_runcmd.py @@ -38,7 +38,7 @@ how it is executed: Note that the ``runcmd`` module only writes the script to be run later. The module that actually runs the script is ``scripts-user`` -in the :ref:`topics/boot:Final` boot stage. +in the :ref:`Final<boot-Final>` boot stage. .. note:: |