docs: Update cloud-init tutorial for 24.04.1 #500
Conversation
With that release comes changes to the distro launcher making no longer necessary for users to run cloud-init commands. The distro launcher does it, so the tutorial can be made shorter. Also there was a caveat about `wsl --install` that's no longer applicable, as that installation command also goes through the launcher.
CarlosNihelton
force-pushed
the
update-cloudinit-tutorial
branch
from
29764b5
to
9b566be
Compare
|
CI Link checks are failing spuriously 🤷🏽♂️ |
|
Question for a follow-up PR maybe: shouldn't we refer to this tutorial in the page screenshotted below?
|
The auto-installation should probably just be removed (discussed previously with JB). As this PR relates to updating the doc it should point to, I think we could remove it here. |
There was a problem hiding this comment.
Thanks a lot Carlos. The changes with the new release and the revisions in the tutorial make this story a lot more clear.
I have added some minor comments for you to consider.
The CI seems to be failing because two links are timing out:
- Link to Code of Conduct on homepage
index.md: changing this to https://ubuntu.com/community/ethos/code-of-conduct should fix that - Link to Ubuntu page on the Microsoft Store in the cloud-init tutorial. That link may need to be updated too, I found this one that seems to work: https://apps.microsoft.com/detail/9nz3klhxdjp5?hl=en-us&gl=US
docs/tutorials/cloud-init.md
Outdated
| It will register a new Ubuntu-24.04 instance and wait for cloud-init to perform its initialisation tasks. | ||
| That process can take several minutes, depending on the computer and network speeds. |
There was a problem hiding this comment.
Would rewrite slightly to:
This command will register a new Ubuntu-24.04 instance that will be configured automatically by cloud-init.
The process can take several minutes, depending on your computer and network speeds.
docs/tutorials/cloud-init.md
Outdated
| ................... | ||
| status: done | ||
| ``` | ||
|
|
||
| ## Verify that it worked |
There was a problem hiding this comment.
Would consider a more descriptive title here:
Verify automatic configuration by cloud-init
| /home/cn/.hushlogin file. | ||
| jdoe@mib:~$ | ||
| /home/jdoe/.hushlogin file. | ||
| jdoe@mib01:~$ | ||
| ``` | ||
|
|
||
| Once logged into the new distro instance's shell, verify that: |
There was a problem hiding this comment.
Not something that needs to be addressed in this PR, and maybe a matter of taste 😄 but we could include a more compelling configuration setup in future. The functionality is demonstrated clearly but it is not obvious to me what the user is setting up with Octave and ginac-tools. For someone less familiar with auto-configuration or who is seeking a concrete use-case we could help them along with one or more examples for specific scenarios (e.g., data science, asset pipeline, programming in Go...).
|
Next cycle we need to consider if this tutorial and a few others might be a better fit in the how-to guides section. This, for example, includes concise, step-by-step instructions on how to achieve one specific task and could work better as a how-to. |
CarlosNihelton
force-pushed
the
update-cloudinit-tutorial
branch
from
0c80489
to
d35c4f6
Compare
This removes documentation of the autoinstall feature (deprecated) and redirects the old url for autoinstall to the cloud-init doc. Follow up to discussion in #500 .
With that release comes changes to the distro launcher making it no longer necessary for users to run cloud-init commands. The distro launcher does it, so the tutorial can be made shorter and more direct.
Also there was a caveat about
wsl --installthat's no longer applicable, as that installation command also goes through the launcher, both workflows are now consistent.