chef / chef/chef-web-docs

Move berkshelf, roles, environments to Legacy section

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

Nobody has claimed this yet.

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

Description

User Story

As a <role: Developer, SysAdmin, etc.>, I will use this work when I want to ...

Description

We need to move the undesirable paths into Legacy. Needs a note that these are not the preferred path and to use Cookstyle (berks) or Policyfiles (roles & environments)

chef-workstation/berkshelf
attributes/roles
attributes/environments

Chef Version

<! Tell us which version of Chef Infra/Workstation/InSpec you need docs for) >

Platform Version

<! Tell us which Operating System distribution and version you're running a Chef product on. >

Definition of Done
Demo Script / Repro Steps

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 documentation pages for chef-workstation/berkshelf, attributes/roles, and attributes/environments, then inspect how the Legacy section and navigation are organized. Move those paths there and add the requested note about Cookstyle (berks) and Policyfiles (roles and environments); done means all three paths appear under Legacy with the warning in place.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.