chef / chef/chef-web-docs

A better left nav

Open
#2,896 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect: Documentation Epic Type: Docs Debt
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

Navigation Spreadsheet
docs.chef.io Navigation.xlsx

  • Supermarket moves out of Infra
  • Infra top-level header
  • Infra Client Nav
  • Revise Automate Nav

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 linked docs.chef.io Navigation.xlsx spreadsheet and compare its navigation requirements with the current documentation site. Done means the Supermarket, Infra, Infra Client, and Automate navigation changes listed in the issue are reflected in the docs; confirm the intended structure before making broad changes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.