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

Doc: Break up the vic-machine create options topic and merge in the examples #26

Closed
stuclem opened this issue Mar 8, 2017 · 5 comments
Assignees
Labels
area/pub/vsphere Published documentation for vSphere administrators area/pub Published documentation for end-users product/engine Related to the vSphere Integrated Containers Engine

Comments

@stuclem
Copy link
Contributor

stuclem commented Mar 8, 2017

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.

@stuclem stuclem added the area/pub Published documentation for end-users label Mar 8, 2017
@stuclem
Copy link
Contributor Author

stuclem commented Mar 8, 2017

@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?

@corrieb
Copy link
Contributor

corrieb commented Mar 9, 2017

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 stuclem modified the milestone: Doc for 1.1 Mar 21, 2017
@stuclem stuclem added the product/engine Related to the vSphere Integrated Containers Engine label Mar 22, 2017
@hickeng
Copy link
Member

hickeng commented Mar 30, 2017

@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.

@stuclem
Copy link
Contributor Author

stuclem commented Apr 4, 2017

@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.

@stuclem stuclem modified the milestones: Doc for 1.1, Doc for 1.1 refresh Apr 4, 2017
@stuclem
Copy link
Contributor Author

stuclem commented Apr 28, 2017

Too big a job for the 1.1.1 doc refresh. Moving to 1.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/pub/vsphere Published documentation for vSphere administrators area/pub Published documentation for end-users product/engine Related to the vSphere Integrated Containers Engine
Projects
None yet
Development

No branches or pull requests

3 participants