Mirantis / Mirantis/cri-dockerd
Improve documentation
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- Go
- Stars
- 1.4k
- Forks
- 356
- Avg merge
- 4d 4h
- Merged PRs (30d)
- 3
Description
The project could use some improved documentation. This is a ticket to track initial topics that come to mind. These should be setup to follow gihub's expected MD locations.
- Design overview & history
- How to install an use cri-dockerd
- Give examples for major environments using the project
- A development setup
- How to build the project from source
- How to run the built binary in a development environment (minikube or something similar)
- How to run the tests
- Contributing guidelines
- Code of Conduct
- A release process and cadence
- Contributors file
Contributor guide
No contributing guide indexed for this repository
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
No specific files are named. Review the existing documentation and GitHub’s expected Markdown locations, then assess the unchecked topics: the design overview and history, environment examples, contributing guidelines, and release process. Done means the selected missing topics are documented in the appropriate locations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100