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.

Sign up for GitHub

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

Jump to bottom

Start of CLI guide. #147

Merged
merged 3 commits into from
May 22, 2018
Merged

Start of CLI guide. #147

merged 3 commits into from
May 22, 2018

Conversation

mchiang0610
Copy link
Contributor

@mchiang0610 mchiang0610 commented May 18, 2018 •
edited
Loading

TODO:

  • Add in ChefDK materials
  • Clean syntax
  • If we have more examples here, we should add them

@mchiang0610
Start of CLI guide.
2a15efb 
TODO:
- Add in ChefDK materials
- Clean MD syntax
@mchiang0610 mchiang0610 requested a review from a team May 18, 2018 16:19
tyler-ball
tyler-ball approved these changes May 18, 2018
View reviewed changes
Copy link
Contributor

@tyler-ball tyler-ball left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor suggestion but looks good otherwise.

I do think in the future it would be nice to auto-generate this as a copy of the help text somehow so they do not get out of sync

www/site/content/docs/chef-workstation/cli-reference.md Outdated
For example:

```
chef-run web01 service nginx action=restart
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think one of these examples should be only service nginx without any properties, and we should also specify some non action properties. Perhaps

chef-run web01 service nginx
chef-run web01,web02 service nginx action=restart
chef-run web[1:2] service nginx priority=20 action=stop

marcparadise
marcparadise reviewed May 21, 2018
View reviewed changes
www/site/content/docs/chef-workstation/cli-reference.md Outdated
-i, --identity-file PATH SSH identity file to use when connecting.
--[no-]install Install Chef client on the target host(s) if it is not installed.
This defaults to enabled - the installation will be performed
if there is no Chef client on the target(s).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that the sudo branch has merged, these options need refreshing.

@mchiang0610
sudo changes.
66a5af3 
updating to reflect the sudo changes.
@mchiang0610
update example text.
c0137d7
@mchiang0610 mchiang0610 merged commit ebc3fd8 into master May 22, 2018
@chef-ci chef-ci deleted the docs-cli-ref branch May 22, 2018 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcparadise marcparadise marcparadise left review comments

@tyler-ball tyler-ball tyler-ball approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mchiang0610 @marcparadise @tyler-ball