Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #211

Open
7 of 11 tasks
nwneisen opened this issue Jul 19, 2023 · 1 comment
Open
7 of 11 tasks

Improve documentation #211

nwneisen opened this issue Jul 19, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nwneisen
Copy link
Collaborator

nwneisen commented Jul 19, 2023 •
edited

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
@nwneisen nwneisen added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 19, 2023
@nwneisen nwneisen mentioned this issue Jul 20, 2023
Merged
@2rs2ts
Copy link

2rs2ts commented Oct 26, 2023

This just came up in the slack channel as a potential docs improvement; if you want to add it in your checklist please feel free:

  • Elaborate on what the options for --network-plugin are and why a user would need to set it to anything instead of leaving it at the default

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@2rs2ts @nwneisen