Add plugin writer docs for setting up a Repository
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: 6371, https://pulp.plan.io/issues/6371
The Plugin Walkthrough[0] has information about about how to set up different classes that the plugin writer needs to define like Remotes, Content, etc. It doesn't mention Repositories though. Below are some suggestions about what this section should contain.
CONTENT_TYPES
- Plugin writers need to set CONTENT_TYPES with the content types that the Repository can contain.
finalize_new_version()
- Plugin writers can override finalize_new_version() on Repository to validate/munge content
- They can call remove_duplicates() to remove duplicates based on repo_key_fields
- There are validation methods in repo_version_utils they can use too (eg validate_repo_version())
[0] https://docs.pulpproject.org/plugins/plugin-writer/plugin-walkthrough.html
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 with the Plugin Walkthrough linked in the issue and find the section describing plugin-writer classes. Add Repository guidance covering CONTENT_TYPES, finalize_new_version(), remove_duplicates(), and validation methods from repo_version_utils. Done means the walkthrough explains these setup and validation options clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100