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

Clarify boothook docs #4543

Merged
merged 3 commits into from
Oct 27, 2023

Conversation

holmanb
Copy link
Member

@holmanb holmanb commented Oct 24, 2023

Clarify boothook docs

Additional Context

See commit messages for explanations

@holmanb holmanb requested a review from s-makin October 24, 2023 00:46
The way that user-data format doc page is currently written, it seems that
boothooks _are_ user-data. Don't specify both.
A reminder that a user has to be aware that the system is booting on a page
that describes the order in which the system is booting is unnecessary.

Also, calling out a specific module from cloud-config is odd and unnecessary.
@holmanb holmanb force-pushed the holmanb/boothook-clarifications branch from 70af625 to 2c01009 Compare October 24, 2023 00:47
Copy link
Contributor

@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

I think this makes sense. Thanks for taking the lead on this - I agree it's better not to present these terms without them being explained anywhere, and if the user doesn't need to know about boothooks at all then this definition/term should be avoided except in the dev docs.

Copy link
Contributor

@aciba90 aciba90 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for cleaning this up!

Copy link
Collaborator

@blackboxsw blackboxsw left a comment

Choose a reason for hiding this comment

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

MOAR linking FTW. Approved after this changeset.

Co-authored-by: Chad Smith <chad.smith@canonical.com>
@blackboxsw blackboxsw force-pushed the holmanb/boothook-clarifications branch from 4ffbe47 to 90dbed5 Compare October 27, 2023 19:57
Copy link
Collaborator

@blackboxsw blackboxsw left a comment

Choose a reason for hiding this comment

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

There was a stray + as part of my suggested fix. force-pushed that and +1

@blackboxsw blackboxsw merged commit c1272f3 into canonical:main Oct 27, 2023
holmanb added a commit to holmanb/cloud-init that referenced this pull request Oct 31, 2023
blackboxsw pushed a commit that referenced this pull request Nov 2, 2023
blackboxsw pushed a commit to blackboxsw/cloud-init that referenced this pull request Nov 6, 2023
holmanb added a commit that referenced this pull request Nov 14, 2023
holmanb added a commit that referenced this pull request Nov 14, 2023
holmanb added a commit that referenced this pull request Nov 14, 2023
holmanb added a commit that referenced this pull request Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants