Update https://docs.chef.io/quick_start/ to use chef-run
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
General details
Link to page & section that needs updated: https://docs.chef.io/quick_start/
Business group: product
Product owner: Tim Smith
Team: Workstation
Date update needs to be published: Post 17 launch
Product
- Chef Automate
- Chef Habitat
- Chef Infra Client
- Chef Infra Server
- Chef InSpec
- Chef Workstation
- Other:________________
Update details
We want to update this page to walk users through using chef-run instead of making configuration changes on their local systems. This gets users into the ad-hoc flow that chef-run applies vs. the chef-client local mode setup which is a throwaway trick.
Existing resources
GitHub Repository:
Issue link(s):
PR link(s):
AHA! link(s):
Other draft documentation:
Related design, business docs, or other information:
Review
Name of technical reviewer:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the quick start page at https://docs.chef.io/quick_start/ and review its current local-mode setup. Update the walkthrough to use chef-run for Chef Workstation's ad-hoc flow, replacing the throwaway local configuration approach; the page should clearly guide users through chef-run after the Post 17 launch.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100