chef / chef/chef-web-docs

[INTAKE] Rewrite the Supermarket overview page

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

Nobody has claimed this yet.

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

Description

Product manager: Tim Smith

Project overview

Rewrite the Supermarket overview page at https://docs.chef.io/supermarket/. This page does not convey the value or use of the product. It needs to sell users on Supermarket and explain where Supermarket fits into their workflow.

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

Start by reviewing the current Supermarket overview page at https://docs.chef.io/supermarket/ and compare its content with the issue's stated goals. Identify what users need to understand about Supermarket's value and its place in their workflow; the rewrite is done when the overview clearly communicates both.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.