docs icon indicating copy to clipboard operation
docs copied to clipboard

Rework CCM Setup Docs

Open ryanrichter94 opened this issue 3 years ago • 3 comments

Wanna go through and rework the CCM setup docs. More clearly define the 6 options for install on all of the 3 CCM packages. Possibly provide recommended options to cut down on screen space/overload. Also cut down on the block quote usage as it makes the page very hard to follow.

ryanrichter94 avatar Jan 18 '22 22:01 ryanrichter94

Good addition here is to ensure examples all use the same convention for package parameters (: as opposed to =)

steviecoaster avatar Jan 20 '22 20:01 steviecoaster

The Style Guide indicates we use =:

When setting a value to an option, always put an equals (=) between the name and the setting, e.g. --source="'local'".

pauby avatar Jan 21 '22 13:01 pauby

Actually, you said package parameters which the Style Guide says:

Now here is that example written with best practices (again line breaks added for readability - there are not line continuations for choco):

choco upgrade pkg1 -y --source="'https://community.chocolatey.org/api/v2'" --package-parameters="'/Option:Value /Option2:value with spaces'" --c4b-option="'Yaass'" --option-that-is-new="'dude upgrade'"

So agreed 😄

pauby avatar Jan 21 '22 13:01 pauby