subiquity/doc
Chris Peterson d812919366 autoinstall: enforce top-level keys
Subiquity currently ignores invalid top-level keys, but this has likely
been a major source of confusion of autoinstall capabilities.

In future versions, the following autoinstall config will throw an
AutoinstallValidationError:

    version: 2
    interactive-sections:
        - identity
    literally-anything: lmao

This patch adds warnings for version 1 and will begin to throw
an AutoinstallValidationError on these instances in version 2 once
it has been enabled.
2024-03-25 19:52:39 -07:00
..
.sphinx Add search-bar Go button. 2024-01-10 16:17:57 +01:00
explanation Language and formatting review of Explanations. 2023-10-25 19:58:05 +02:00
howto quickstart: fix autoinstall indents 2024-03-09 21:51:39 -07:00
reference autoinstall: enforce top-level keys 2024-03-25 19:52:39 -07:00
reuse Language and formatting review of the Reference section. 2023-10-26 11:40:07 +02:00
tutorial Merge pull request #1862 from rkratky/FR-5768_review-howtos 2023-10-27 10:16:14 -06:00
.custom_wordlist.txt Add ubuntu-image reference. 2024-03-07 15:09:47 +01:00
.gitignore Fix greedy .gitignore. 2023-10-18 14:37:11 +02:00
.wokeignore Adopt Docs Starter Pack config. 2023-10-06 14:50:56 +02:00
.wordlist.txt doc: fix 2 spelling errors 2023-10-24 15:37:02 +02:00
Makefile Add docs checks to GH workflows: 2023-10-23 21:56:36 +02:00
README.md doc: update readme for removal of `documentation` 2023-11-02 18:32:56 +02:00
conf.py Update Sphinx extension names. 2024-01-10 16:17:50 +01:00
custom_conf.py Update and fix project navigation 2023-10-23 16:28:43 +02:00
google8dda472a993637b7.html Add Google Consople verif. file. 2023-10-18 15:48:15 +02:00
index.rst Review howto language and formatting. 2023-10-27 18:06:59 +02:00
intro-to-autoinstall.rst Fix Sphinx/rST warnings. 2024-01-10 16:17:57 +01:00

README.md

Documentation

This doc folder is the location of documentation for Subiquity.

In the not distant past, there was also a ../documentation folder, but that is now an obsolete copy of what was on Discourse.

Local preview

To build this documentation, you can run make install from this folder to create the virtual environment.

Then run the make run command, which will build a html version of the docs, and serve the docs in the virtual environment. This is very convenient if you are working on them and want your saved changes to be reflected as a working preview.