VCH Deployment Options, Examples, and Help are presented in a disjointed way #431
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
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.The text was updated successfully, but these errors were encountered: