kubesphere / kubesphere/ks-devops
Request to refine README.md
Open
- Dominant language
- Go
- Stars
- 164
- Forks
- 140
- PR merge metrics
- No merged PRs in 30d
Description
More and more people begin to pay attention to this project, which is a very good start. But there is still a doubt about relationship between KubeSphere and ks-devops project due to lack of depict. And the structure of README is unfriendly for now.
So I request to refine our documentation:
- Describe relationship between KubeSphere and ks-devops
- Restructure README
Contributor guide
Research direction
Start with README.md and review how it currently presents ks-devops. Clarify the relationship between KubeSphere and ks-devops, then restructure the README for easier navigation. Done means both requested documentation changes are reflected in the README.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100