-
Notifications
You must be signed in to change notification settings - Fork 356
docs: Add cloud-init Guides #2929
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
Conversation
…ng cloud-init on Rocky Linux
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.
@wsoyinka If you elect not to fix this, I can certainly do it with editing passes on each document after they are merged.
|
||
|
||
# **I. cloud-init Fundamentals: The Architecture of First Boot** | ||
|
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.
Hello @wsoyinka Nice job on the content! The level 1 heading here is not needed. It will come down from the meta "Title:" and populate. This line should just be deleted. Second, in all of these headings, I don't think the additional bold facing works. Each heading level has its own emphasis, so adding bold to the headings is not needed. That is throughout all of these documents.
|
||
|
||
# **II. First Contact: Simple Bootstrapping with the Rocky Linux 10 QCOW2 Image** | ||
|
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.
Again, this level 1 heading should be deleted and just allow the Title meta to populate it. If you like, you can add a level 2 heading that has "with the Rocky Linux 10 QCOW image" before the content starts OR add that to the Title meta. Again, the additional bold facing of the headings throughout is not needed as each heading will add its own emphasis.
|
||
!!! tip "Save Disk Space with Backing Files" | ||
A full copy of the image can be large. To save disk space, you can create a *linked clone* that uses the original image as a backing file. This creates a much smaller `qcow2` file that only stores the differences from the original. | ||
|
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.
You will need an extra LF after the admonition title line for proper formatting:
!!! tip "Save disk space with backing files"
A full copy....
--- | ||
|
||
# **III. The Configuration Engine: Deep Dive into cloud-init Modules** | ||
|
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.
Again, just delete this level 1 heading, the Title Meta will fill it in.
3. **Boot and Verify:** After booting, SSH in and use `curl localhost` to see the new homepage. | ||
|
||
!!! tip "Writing Binary Files" | ||
The `write_files` module is not limited to text. By specifying an `encoding`, you can deploy binary files. For example, you can use `encoding: b64` to write base64-encoded data. For advanced use cases, refer to the [official `write_files` documentation](https://cloudinit.readthedocs.io/en/latest/topics/modules.html#write-files). |
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.
Once again, the admonition needs an extra LF after the title line. It looks like you need that on all of your admonitions in each of the documents here.
--- | ||
|
||
# **IV. Advanced Provisioning: Networking and Multi-Part Payloads** | ||
|
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.
Same here, remove the level 1 heading altogether
* New translations active_directory_authentication.md (French) * New translations active_directory_authentication.md (German) * New translations rl9_network_manager.md (French) * New translations nmtui.md (French) * New translations podman.md (French)
* New translations tracking_and_nontracking_branch.md (German) * New translations git_pull_vs_git_fetch.md (German) * New translations git_remote_add.md (German) * New translations git_pull_vs_git_fetch.md (German)
…ky-linux#2930) * desktop category: Rewrite some desktop app guides for Rocky Linux 10 * docs/desktop: remove unused translated guides * desktop category: add new guide for valuta app * desktop category: apply @sspencerwire review feedbak to PR 2930
* `valuta.md` duplicated level 1 and 2 header content. Change out contractions for words. * `decoder.md` fix numbered list formatting in second paragraph * `screenshot.md` remove duplicated 1 and 2 header content. Change the keyboard commands to markdown equivalents. Minor sentence simplification.
Test results for 774e620:
|
PR creates a new and complete guide for using cloud-init on Rocky Linux.