-
Notifications
You must be signed in to change notification settings - Fork 155
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
Add ubuntu-image reference #1929
Conversation
d9446d0
to
1b49298
Compare
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.
LGTM
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. Most of my comments are things you could not know about because the current doc is outdated.
Sorry, looks like I hit the merge button too early! |
NP. I spoke to Paul, and I submit a new PR reflecting his suggestions. |
Background
In order to make
ubuntu-image
documentation available to users (considering that a)ubuntu-image
has no online presence other than its GH repo, and b) following the transition to packagingubuntu-image
only as a Snap, it doesn't have a man page), I'd like to add basic reference info about it to the Installation Guide.While at this point, the IG contains only Autoinstall/Subiquity docs, the plan is to expand it to include other kinds of installation-related content. This makes
ubuntu-image
docs a good candidate for addition.Content
This PR only adds a single reference page with basic info about the
ubuntu-image
tool and its command-line options. It's derived from the erstwhileubuntu-image
man page, but the plan is to add other reference and how-to content relating to the tool (mainly its YAML config file schema reference and some practical examples).Fixes FR-6783.