docs: Add WSL tutorial (#5206)

canonical · Apr 25, 2024 · 90c15a6 · 90c15a6
1 parent 8854179
commit 90c15a6
Show file tree

Hide file tree

Showing 6 changed files with 356 additions and 4 deletions.
diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py
@@ -73,7 +73,8 @@
 # Sphinx-copybutton config options: 1) prompt to be stripped from copied code.
 # 2) Set to copy all lines (not just prompt lines) to ensure multiline snippets
 # can be copied even if they don't contain an EOF line.
-copybutton_prompt_text = "$ "
+copybutton_prompt_text = r"\$ |PS> "
+copybutton_prompt_is_regexp = True
 copybutton_only_copy_prompt_lines = False
 
 # -- Options for HTML output --------------------------------------------------

diff --git a/doc/rtd/reference/datasources/wsl.rst b/doc/rtd/reference/datasources/wsl.rst
@@ -37,6 +37,8 @@ the datasource from working.
 For more information about how to configure WSL,
 `check the official documentation <https://learn.microsoft.com/windows/wsl/wsl-config#configuration-settings-for-wslconf>`_.
 
+.. _wsl_user_data_configuration:
+
 User data configuration
 ========================
 
@@ -205,4 +207,3 @@ include file.
   WSL automatically generates those files by default, unless configured to
   behave otherwise in ``/etc/wsl.conf``. Overwriting may work, but only
   until the next reboot.
-
diff --git a/doc/rtd/reference/modules.rst b/doc/rtd/reference/modules.rst
@@ -88,6 +88,9 @@ date. A 5 year timeline may also be expected for changed keys.
 
 .. automodule:: cloudinit.config.cc_users_groups
 .. automodule:: cloudinit.config.cc_wireguard
+
+.. _mod-write_files:
+
 .. automodule:: cloudinit.config.cc_write_files
 .. automodule:: cloudinit.config.cc_yum_add_repo
 .. automodule:: cloudinit.config.cc_zypper_add_repo
diff --git a/doc/rtd/tutorial/index.rst b/doc/rtd/tutorial/index.rst
@@ -14,7 +14,7 @@ capable of.
 Core tutorial
 =============
 
-This tutorial, which we recommend if you are completely new to ``cloudinit``,
+This tutorial, which we recommend if you are completely new to ``cloud-init``,
 uses the QEMU emulator to introduce you to all of the key concepts, tools,
 processes and operations that you will need to get started.
 
@@ -35,3 +35,15 @@ user data script.
    :maxdepth: 1
 
    lxd.rst
+
+WSL tutorial
+============
+
+This tutorial is for learning to use ``cloud-init`` within a ``WSL``
+environment. You will use a ``cloud-init`` user data script to customize a
+``WSL`` instance.
+
+.. toctree::
+   :maxdepth: 1
+
+   wsl.rst
diff --git a/doc/rtd/tutorial/lxd.rst b/doc/rtd/tutorial/lxd.rst
@@ -127,7 +127,7 @@ Which should print the following:
 
 .. code-block::
 
-    Valid cloud-config: system userdata
+    Valid schema user-data
 
 Finally, let us verify that our user data was applied successfully: