Merge pull request #1708 from dbungert/docs-autoinstall-tutorial

docs: autoinstall tutorial

doc/.gitignore

@@ -0,0 +1,2 @@
+_build
+.sphinx

doc/conf.py

@@ -22,7 +22,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Ubuntu Install Guide'
-copyright = f'Canonical Group Ltd, {datetime.date.today().year}'
+copyright = 'Canonical Group Ltd'
 
 # -- General configuration ---------------------------------------------------
 
@@ -34,11 +34,17 @@
 # ones.
 
 extensions = [
-    'm2r2',
+    'sphinx.ext.intersphinx',
     'sphinx_copybutton',
     'sphinx_design',
 ]
 
+intersphinx_mapping = {
+    'cloud-init': (
+        'https://canonical-cloud-init.readthedocs-hosted.com/en/latest',
+         None
+    )
+}
 
 # Add any paths that contain templates here, relative to this directory.
 
@@ -47,8 +53,8 @@
 # The suffix of source filenames.
 source_suffix = '.rst'
 
-# The master toctree document.
-master_doc = 'index'
+# The root toctree document.
+root_doc = 'index'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -62,7 +68,8 @@
 # This pattern also affects html_static_path and html_extra_path.
 
 exclude_patterns = [
-    ".sphinx/venv/*",
+    '.sphinx/venv/*',
+    'README.md',
 ]
 
 # Sphinx-copybutton config options:

doc/index.rst

@@ -1,7 +1,7 @@
 .. _index:
 
-Subiquity documentation
-#######################
+Ubuntu Installation documentation
+#################################
 
 A single sentence that says what the product is, succinctly and memorably
 consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et

doc/reference/autoinstall-reference.rst

@@ -0,0 +1,186 @@
+.. _ai:
+
+Autoinstall configuration reference manual
+******************************************
+
+.. _ai-active-directory:
+
+active-directory
+================
+
+stub
+
+.. _ai-apt:
+
+apt
+=======
+
+stub
+
+.. _ai-codecs:
+
+codecs
+======
+
+stub
+
+.. _ai-debconf-selections:
+
+debconf-selections
+==================
+
+stub
+
+.. _ai-early-commands:
+
+early-commands
+==============
+
+stub
+
+.. _ai-error-commands:
+
+error-commands
+==============
+
+stub
+
+.. _ai-identity:
+
+identity
+========
+
+stub
+
+.. _ai-interactive-sections:
+
+interactive-sections
+====================
+
+stub
+
+.. _ai-kernel:
+
+kernel
+======
+
+stub
+
+.. _ai-keyboard:
+
+keyboard
+========
+
+stub
+
+.. _ai-late-commands:
+
+late-commands
+=============
+
+stub
+
+.. _ai-locale:
+
+locale
+======
+
+stub
+
+.. _ai-network:
+
+network
+=======
+
+stub
+
+.. _ai-oem:
+
+oem
+===
+
+stub
+
+.. _ai-packages:
+
+packages
+========
+
+stub
+
+.. _ai-proxy:
+
+proxy
+=====
+
+stub
+
+.. _ai-refresh-installer:
+
+refresh-installer
+=================
+
+stub
+
+.. _ai-reporting:
+
+reporting
+=========
+
+stub
+
+.. _ai-shutdown:
+
+shutdown
+========
+
+stub
+
+.. _ai-snaps:
+
+snaps
+=====
+
+stub
+
+.. _ai-ssh:
+
+ssh
+===
+
+stub
+
+.. _ai-storage:
+
+storage
+=======
+
+stub
+
+.. _ai-ubuntu-pro:
+
+ubuntu-pro
+==========
+
+stub
+
+.. _ai-updates:
+
+updates
+=======
+
+stub
+
+.. _ai-user-data:
+
+user-data
+=========
+
+stub
+
+.. _ai-version:
+
+version
+=======
+
+stub

doc/reference/index.rst

@@ -5,6 +5,15 @@ Our reference section contains support information for Subiquity.
 This includes details on the network requirements, API definitions, support
 matrices and so on.
 
+Autoinstall reference manual
+============================
+
+
+.. toctree::
+   :maxdepth: 1
+
+   autoinstall-reference.rst
+
 -----
 
 .. toctree::

doc/tutorial/index.rst

@@ -11,20 +11,13 @@ capable of.
 
 -----
 
-Core tutorial
-=============
+Introduction to autoinstall
+===========================
 
-<some blurb here>
+This tutorial introduces the core concepts of autoinstall and is recommended as
+the first step.
 
 .. toctree::
    :maxdepth: 1
 
-Quick-start tutorial
-====================
-
-<some blurb here>
-
-.. toctree::
-   :maxdepth: 1
-
-
+   intro-to-autoinstall.rst