doc: add how-to for validating user data (WIP)

canonical · Jan 30, 2024 · 8ba12d1 · 8ba12d1
1 parent f7d3f23
commit 8ba12d1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/doc/howto/autoinstall-validation.rst b/doc/howto/autoinstall-validation.rst
@@ -0,0 +1,11 @@
+.. _autoinstall_validation:
+
+Validating user data
+====================
+
+Autoinstall user data is validated against a :doc:`JSON schema <../reference/autoinstall-schema>`
+during runtime before it is applied. It can also be validated ahead of time by
+using the `validate-autoinstall-user-data script <https://github.com/canonical/subiquity/blob/main/scripts/validate-autoinstall-user-data.py>`_
+
+A header
+--------
diff --git a/doc/howto/index.rst b/doc/howto/index.rst
@@ -14,14 +14,15 @@ Getting started with autoinstall
 
 .. toctree::
    :maxdepth: 1
-   
+
    Autoinstall quick start <autoinstall-quickstart>
    Autoinstall quick start for s390x <autoinstall-quickstart-s390x>
+   Autoinstall validation <autoinstall-validation>
 
 Found a problem?
 ----------------
 
 .. toctree::
    :maxdepth: 1
-   
+
    report-bugs