bad documents
- Dominant language
- Go
- Stars
- 30.1k
- Forks
- 4.6k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 39
Description
The official documents are too bad. The deployment documents in k8s mode are mixed with those in VM mode. The content of configuration item is too fragmentary and has no globality. I don't know which configuration file the configuration item belongs to and where it should be written.
It's like it's for your internal development. I hope you can work out the document from a new perspective. I don't need to know the principle. I just need to know how to install it
Contributor guide
Research direction
The issue identifies deployment documentation for Kubernetes and VM modes, but no specific files or tests. Start by locating the existing installation and configuration documentation, then separate the two deployment modes and map each configuration item to its file and placement. Done means a newcomer can follow installation instructions without needing implementation principles.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100