cri-dockerd icon indicating copy to clipboard operation
cri-dockerd copied to clipboard

Published 20 hours ago • verified publisher icon Mirantis

Improve documentation

Open nwneisen opened this issue 11 months ago • 1 comments

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
  • [x] How to install an use cri-dockerd
    • [ ] Give examples for major environments using the project
  • [x] A development setup
  • [x] How to build the project from source
  • [x] How to run the built binary in a development environment (minikube or something similar)
  • [x] How to run the tests
  • [ ] Contributing guidelines
  • [x] Code of Conduct
  • [ ] A release process and cadence
  • [x] Contributors file

nwneisen avatar Jul 19 '23 22:07 nwneisen