-
Notifications
You must be signed in to change notification settings - Fork 92
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
Doc: Break up the vic-machine create options topic and merge in the examples #26
Comments
@hickeng has objected in the past to breaking up the options reference topic. However, I believe that by doing so and incorporating the examples into the smaller sections, we will get closer to the scenario-based doc that @hickeng wants, as opposed to the current reference-heavy doc that we currently have. @mlh78750 @karthik-narayan @corrieb what do you think? |
Agreed. I would break it up into Compute, Network, Storage and Authentication. That pretty much covers all of it and helps the users to think about what high-level categories are required when creating a VCH |
@stuclem my primary objection to breaking it up (iirc) was that you cease to be able to search within a single document for an option. I'm all for breaking the detail out into scenario-based doc, and referencing those from a very concise index/glossary style reference. |
@hickeng OK, thanks for clarifying. I don't think that we'll manage this for 1.1, though, as the potential for link breakage and content loss is too great to be doing it at this late stage of the release. |
Too big a job for the 1.1.1 doc refresh. Moving to 1.2. |
The
vic-machine create
options reference is becoming too large to be easily maintainable or navigable. Also, much of the information is duplicated between the options reference and the examples topic.I propose that we break up the options reference into separate topics that match the sections in vch_installer_options.md, and merge the relevant examples from vch_installer_examples.md into those smaller topics.
The text was updated successfully, but these errors were encountered: