chef / chef/chef-web-docs

Data bag doc should mention encryption version 3

Open
#1,859 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

User Story

As a Chef user I want to know all the versions of encrypted data bags available.

Description

The doc on data bags at https://docs.chef.io/data_bags.html mentions encrypted data bag versions 0 -2 but not version 3 which started shipping in Chef 12.

Chef Version

N/A

Platform Version

N/A

Definition of Done

When the docs mention encrypted data bag version 3.

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

Review the data bags documentation at https://docs.chef.io/data_bags.html and compare its encrypted data bag version list with the linked release notes for encrypted data bag version 3. Update the documentation so version 3 is mentioned; the definition of done is that the docs list encrypted data bag version 3.

Written by the indexing model from the issue text.

Assessment

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.