canonical / cloud-init

Official upstream for the cloud-init: cloud instance initialization
https://cloud-init.io/
Other
3.01k stars 887 forks source link

New tutorial #5871

Open s-makin opened 1 week ago

s-makin commented 1 week ago

Proposed Commit Message

docs: Update tutorials

- Applying extensive feedback from Daniele on our tutorials.
- Tutorials have been streamlined so that we now have a space for
alternative deployment methods (e.g. WSL) to be put under "how-to".
- Tutorials can now be kept for demonstrating features and capabilities.
- Additional tutorials can be created using the LXD quickstart as the basis

Merge type

s-makin commented 1 week ago

Thanks for this PR @s-makin! I haven't reviewed the change yet, however it looks like updating the spelling work caused our CI spelling test to fail. You can run the test locally with this: tox -e doc-spelling -- doc/rtd doc/rtd_html

Currently this yields:

WARNING: doc/rtd/development/style_docs.rst:93: : Spell check: copybutton: Our documentation uses the Sphinx extension “sphinx-copybutton”, which creates.
WARNING: doc/rtd/howto/run_cloud_init_locally.rst:74: : Spell check: qemu: qemu-system-<arch>.
WARNING: ../../module-docs/cc_chef/data.yaml:1: : Spell check: validator:  (string) The name of the chef-validator key that Chef Infra Client uses to access the Chef Infra Server during the initial Chef Infra Client run..
WARNING: ../../module-docs/cc_growpart/data.yaml:1: : Spell check: dev:  (array of string) The devices to resize. Each entry can either be the path to the device’s mountpoint in the filesystem or a path to the block device in ‘/dev’. Default: .
WARNING: Found 4 misspelled words

Thanks, I didn't know about that - funnily enough, the CI test only showed up two of those four, while when I ran the test locally, I only got 3! Not sure what the cause of the inconsistency is, but I used your list to fix them.