Documentation for the existing shape of Chef Infra Server
Open
Nobody has claimed this yet.
Epic
- Dominant language
- Erlang
- Stars
- 303
- Forks
- 211
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 5
Description
As a developer of Chef Infra Server I would like to understand the interactions between the various components.
This can be done with:
- Architecture diagrams (some suggestions are as below)
- interactions of components,
- lifecycle of a request
- request flow
- cookbook upload
- cookbook download
- searching parsing
- Documentation (some suggestions are as below)
- The setup and use of dev-env
- The Release process
- The various testing pipelines
- Habitat builds
- matrix of versions of deps supported in past 2 releases.
Aha! Link: https://chef.aha.io/features/SH-430
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 mapping the existing Chef Infra Server component interactions and the listed request, cookbook upload/download, and search flows. Review the proposed dev-env, release, testing pipeline, Habitat build, and dependency-version documentation areas, using the Aha feature for context; done requires agreed architecture diagrams and documentation covering the selected scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- erlang
- Domain
- backend, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100