The help text for repository on distribution doesn't make sense
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: daviddavis (daviddavis)
Redmine Issue: 8564, https://pulp.plan.io/issues/8564
The help text for the repository field for distributions in the api docs says, "The latest RepositoryVersion for this Repository will be served.". It comes from here. In pulp_file and other plugins with publications, I don't think this is correct.
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 in pulpcore/app/serializers/publication.py around the referenced repository field and inspect how its help text appears in the API docs. Compare the statement with the behavior of distributions in pulp_file and other publication plugins, then update the wording so the generated documentation is accurate and verify the affected API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100