chef / chef/chef-web-docs

Supermarket monitoring page should give you useful information

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

Nobody has claimed this yet.

Documentation
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.
The current Supermarket monitoring page just tells you there's data, but nothing about what format it's in or what to do with it.

https://docs.chef.io/supermarket_monitor/

Describe the solution you'd like
At the very least it should mention what format the data is in and give examples. It could then tell you to use your monitoring tool to parse that data.

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 with the Supermarket monitoring page at https://docs.chef.io/supermarket_monitor/ and locate its source in the documentation repository. Determine the data format and suitable examples from the existing page or project context, then document those details and explain that users should use their monitoring tool to parse the data. Done means the page provides format information, examples, and parsing guidance.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.