Harmonize Infra security documentation
Open
Nobody has claimed this yet.
Aspect: Documentation
Topic: Credentials
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a user or developer, I want to understand Chef Infra security, make informed decisions about the type of certificate I should use, and use that certificate--even custom certificates--easily.
Certs are hard for everyone, but we can do better.
Description
Harmonize Infra Security docs:
- Server Security https://docs.chef.io/server/server_security/
- Chef Client Securityhttps://docs.chef.io/chef_client_security
- Server Auth https://docs.chef.io/server/auth/
- Secrets management https://github.com/chef/chef-web-docs/issues/625
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Server Security, Chef Client Security, and Server Auth pages linked in the issue, then review the related secrets-management issue #625. Identify overlapping or missing guidance about certificate choices and custom certificates; the work is done when the relevant security documentation presents consistent, usable guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100