[Docs] Improve plugin API reference section of the guide
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: @dralley (dalley)
Redmine Issue: 7476, https://pulp.plan.io/issues/7476
https://docs.pulpproject.org/pulpcore/plugins/index.html#plugin-writer-s-guide
Feedback from Gerrod:
Knowing how Pulp works in order to make changes is definitely the most challenging aspect of contributing. I think the writer’s guide does a good job describing all the different aspects of Pulp and plugins. The plugin api reference section is a bit barren though.
I think what he's referring to is that several sections like the models and viewsets have almost no description, but then other sections such as downloaders have a lot of detail.
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 Writer’s Guide at docs.pulpproject.org/pulpcore/plugins/index.html, especially the plugin API reference section. Compare the sparse models and viewsets sections with the more detailed downloaders section, then expand the API descriptions so the reference is consistently useful to plugin contributors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100