chef / chef/chef-web-docs

Expand quickstart to give better post-complete action

Open
#3,379 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation Status: Untriaged Type: Bug
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

Is your feature request related to a problem? Please describe.

This page is not the most helpful. It teaches you to weirdly run chef on your own system in a way you'd never do and then it just leaves you hanging. This page needs to get blown up and replaced with something useful that actually gets people headed in the right direction.

Describe the solution you'd like

  • chef run?
  • something with test kitchen?

Describe alternatives you've considered

I'm open to anything, but right now post completion of this what do you do

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the quickstart page in the chef-web-docs repository and review the current flow described by this issue. Define a useful post-completion path, such as the proposed Chef run or Test Kitchen follow-up, and consider the work done when the page no longer leaves users without next steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.