chef / chef/chef-web-docs

Chef CLient 12.12 New Node Attribute API

Open
#505 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect: Documentation Component: Chef Infra Client Topic: API
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

With the release of Chef Client 12.12 there is a new node attribute API.

https://docs.chef.io/release_notes.html#new-node-attribute-read-write-unlink-and-exist-apis

This API is not mentioned on the documentation page about attributes.

https://docs.chef.io/attributes.html

Adding information about the new API to the documentation page would be helpful to new users attempting to use the new API.

Januar 25, 2021: These still aren't documented!

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 docs.chef.io/attributes.html and compare it with the linked Chef Client 12.12 release notes. Document the node attribute read, write, unlink, and exist APIs on the attributes page; done means new users can find the API information there.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.