chef / chef/chef-web-docs

Add warning to Berkshelf, Roles, Environments documentation

Open
#3,666 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.

We need to make it clear to users that the future is Policyfiles. We should be warning in these documents that this is a legacy workflow and new users should not adopt these patterns.

Describe the solution you'd like

A nicely worded warning on each page that documents legacy workflows

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

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 covering Berkshelf, Roles, and Environments, then review how each legacy workflow is described. Add a clearly worded warning to each relevant page explaining that Policyfiles are the recommended path for new users and that these workflows should not be newly adopted.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.