Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New tutorial #5871

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

New tutorial #5871

wants to merge 9 commits into from

Conversation

s-makin
Copy link
Contributor

@s-makin s-makin commented Nov 14, 2024

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

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

@github-actions github-actions bot added the documentation This Pull Request changes documentation label Nov 14, 2024
Copy link
Collaborator

@a-dubs a-dubs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small nit inline, but looks good otherwise!

Cheers, @s-makin

doc/rtd/tutorial/index.rst Outdated Show resolved Hide resolved
Copy link
Member

@holmanb holmanb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@s-makin
Copy link
Contributor Author

s-makin commented Nov 18, 2024

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.

Copy link
Member

@holmanb holmanb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR @s-makin! I left some comments inline.

doc/rtd/tutorial/qemu.rst Outdated Show resolved Hide resolved
@@ -0,0 +1,20 @@
.. _launching:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an index for different pages - each page describes how to launch cloud-init on a particular platform. Currently this only lists WSL, however we already have a single page which explains how to launch instances on various platforms: lxd, libvirt, multipass, and qemu. Given the overlap, I think that it would make sense to link from this page to each of those platforms - but we may want to split that page into individual ones to live next to wsl.rst.

@s-makin What do you think about that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that would make sense. Do you want me to do that as part of this PR or as a separate one?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As part of this PR, if you don't mind.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :)

doc/rtd/development/style_docs.rst Outdated Show resolved Hide resolved
doc/rtd/index.rst Show resolved Hide resolved
@@ -0,0 +1,20 @@
.. _launching:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As part of this PR, if you don't mind.


Quick-start tutorial
====================
* :ref:`Part 1: quick deployment <tutorial_lxd>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A part 1 without a part 2 feels odd. Were you planning to add more here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am yes, but it won't be part of this PR because it's still in the early draft stage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This Pull Request changes documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants