StealthOS/subiquity
StealthOS
/
subiquity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Language and formatting review of the Reference section.

This commit is contained in:
Robert Krátký 2023-10-25 14:40:33 +02:00
parent 968ba4e6b4
commit 0dd4ee7bae
5 changed files with 219 additions and 341 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/.custom_wordlist.txt
View File

@ -17,6 +17,7 @@ LUKS
LV
LVM
LinuxONE
Mantic
MiB
NIC
Netplan
@ -36,7 +37,7 @@ UEFI
URI
Zdev
amd
authorized-keys
authorized
autoinstall
autoinstaller
autoinstalls
@ -51,6 +52,7 @@ debian-installer
el
flavor
geoip
geolocation
globbing
hostname
iSCSI

514
doc/reference/autoinstall-reference.rst
View File

File diff suppressed because it is too large Load Diff

30
doc/reference/autoinstall-schema.rst
View File

@ -1,35 +1,31 @@
.. _autoinstall_schema:
Autoinstall schema
******************
==================
The server installer validates the provided autoinstall configuration against a
:ref:`JSON schema<autoinstall_JSON_schema>`.
The server installer validates the provided autoinstall configuration against a :ref:`JSON schema<autoinstall_JSON_schema>`.
How the configuration is validated
==================================
----------------------------------
Although the schema is presented below as a single document, and if you want
to pre-validate your configuration you should validate it against this document, the
configuration is not actually validated against this document at run time. What
happens instead is that some sections are loaded, validated, and applied
first, before all other sections are validated. In detail:
This reference manual presents the schema as a single document. Use it pre-validate your configuration.
At run time, the configuration is not validated against this document. Instead, configuration sections are loaded and validated in this order:
1. The reporting section is loaded, validated and applied.
2. The error commands are loaded and validated.
3. The early commands are loaded and validated.
4. The early commands, if any, are run.
5. The configuration is reloaded, and now all sections are loaded and validated.
5. The configuration is reloaded, and all sections are loaded and validated.
This is so that validation errors in most sections can be reported via the
reporting and error-commands configuration, as all other errors are.
This is to ensure that potential validation errors in most sections can be reported using the reporting and error-commands configuration the same way as other errors.
.. _autoinstall_JSON_schema:
Schema
======
------
The `JSON schema`_ for autoinstall data is as follows:
The `JSON schema`_ for autoinstall data:
.. code-block:: JSON
@ -579,11 +575,11 @@ The `JSON schema`_ for autoinstall data is as follows:
}
Regeneration
============
------------
The schema above can be regenerated by running ``make schema`` in a Subiquity
source checkout.
To regenerate the schema, run ``make schema`` in the root directory of the `Subiquity source repository`_.
.. LINKS
.. _JSON schema: https://json-schema.org/
.. _Subiquity source repository: https://github.com/canonical/subiquity

8
doc/reference/index.rst
View File

@ -1,14 +1,12 @@
Reference
*********
=========
Our reference section contains support information for Subiquity.
This includes details on the network requirements, API definitions, support
matrices and so on.
The reference section contains support information for Subiquity. This includes details on the network requirements, API definitions, support matrices, and other.
-----
Autoinstall reference manual
============================
----------------------------
.. toctree::
:maxdepth: 1

4
doc/reuse/substitutions.txt
View File

@ -1,3 +1,3 @@
.. |ubuntu-latest-version| replace:: 23.04
.. |ubuntu-latest-codename| replace:: Lunar Lobster
.. |ubuntu-latest-version| replace:: 23.10
.. |ubuntu-latest-codename| replace:: Mantic Minotaur
.. role:: command(literal)