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

VCH Deployment Options, Examples, and Help are presented in a disjointed way #431

Closed
zjs opened this issue Jul 11, 2017 · 1 comment
Closed
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

@zjs
Copy link
Member

zjs commented Jul 11, 2017

Understanding a the available deployment options, what they mean, and how to use them currently requires flipping through three different sources of information, with little interlinking: VCH Deployment Options, Advanced Examples of Deploying a VCH (and Deploy a VCH to an ESXi Host with No vCenter Server and Deploy a VCH to a Basic vCenter Server Cluster), and vic-machine's help output.

It might be helpful to de-duplicate information about a given topic. For example, it's not clear why we have an example of specifying volume stores separately from the examples in the documentation about the --volume-store option.

It would be helpful to organize related vic-machine arguments into groups.

As an alternate model, git help commit provides a similar amount of information in a consolidated way: by describing the command, enumerating it's options, expanding on more complicated topics, and then giving examples.

As an even smaller, but still significant, change: docker help create sorts and vertically aligns option short names, long names, and descriptions, making the output much easier to skim.

@zjs zjs added product/engine Related to the vSphere Integrated Containers Engine area/pub Published documentation for end-users area/pub/vsphere Published documentation for vSphere administrators labels Jul 11, 2017
@stuclem
Copy link
Contributor

stuclem commented Jul 25, 2017

@zjs I agree completely. I already have #26 open to try to address this.

Can I close this one as a dup?

@stuclem stuclem self-assigned this Jul 26, 2017
@zjs zjs closed this as completed Aug 2, 2017
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

2 participants