Rework Infra Server Overview Page
Open
@kagarmoe is already working on this.
Since Oct 23, 2021.
Component: Chef Infra Client
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.
There isn't a true about Chef Infra Server page. There's an overview section, but the closest thing is https://docs.chef.io/server/ which doesn't really help a person brand new to Infra Server. It jumps right into the internal components of the server, which is about the last thing you need to know in an introduction, but you leave the doc not knowing what the actual components of the server are that matter.
We need an "About Chef Infra Server" page at the top with the following ideas:
- What is the Infra Server for: Storing policy for use by Infra Client
- Objects we store: Policyfiles, Nodes, Clients, Cookbooks
- High level RBAC components: Orgs, Users, Groups
All high level descriptions with links off to the better in depth pages.
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.
Assessment
This issue has not been assessed yet.