chef / chef/chef-web-docs

Add Attribute examples and descriptions to the policyfile documents

Open
#4,092 0 comments 0 reactions 1 assignee View on GitHub

@snohio is already working on this.

Since May 5, 2023.

Component: Chef Infra Client Documentation Size: S Status: Good First Issue Status: Untriaged
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 customer World Bank (among others) would like to have examples and descriptions of how to utilize attributes in the policyfiles so that they can understand how they work.

Describe the solution you'd like

Include examples and descriptions of Attributes in the https://docs.chef.io/config_rb_policyfile/ and https://docs.chef.io/policyfile/ documents.

Describe alternatives you've considered

The alternative is that the SA and CA teams continue to hold peoples hands when they ask how to do this.

Additional context

None needed.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.