-
Notifications
You must be signed in to change notification settings - Fork 887
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
base: main
Are you sure you want to change the base?
New tutorial #5871
Conversation
There was a problem hiding this 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
There was a problem hiding this 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
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. |
There was a problem hiding this 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.
@@ -0,0 +1,20 @@ | |||
.. _launching: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done :)
@@ -0,0 +1,20 @@ | |||
.. _launching: |
There was a problem hiding this comment.
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>` |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Proposed Commit Message
Merge type