Improve package management design documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 466
- Forks
- 338
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 8
Description
Feature Request
Is your feature request related to a problem? Please describe:
It's currently very difficult to understand the design of TiUP with respect to the handling of nightly builds, component discovery, etc.
TiUP uses a nightly build tagging system that apparently doesn't match the tagging system used in downloadable packages, Docker images, or elsewhere. The TiUP package discovery and management system should be fully documented.
Describe the feature you'd like:
Describe alternatives you've considered:
Teachability, Documentation, Adoption, Migration Strategy:
Contributor guide
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
Start by locating the existing TiUP documentation and the package discovery and management entry points; no specific file or test is named in the issue. Compare the nightly-build tagging behavior with downloadable packages and Docker images, then document the package-management design and discovery rules. Done means contributors can understand how these sources and tags relate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100