Add documentation for Exporter plugins
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: amacdona@redhat.com (amacdona@redhat.com)
Redmine Issue: 3346, https://pulp.plan.io/issues/3346
Exporters should be documented separately from the other objects because in many cases, they will exist in their own isolated plugin.
For example a filesystem exporter would need to be its own plugin because writing publications to a filesystem is a general need and can be done for any content type.
This documentation should explain how to implement the Exporter Model, Viewset, and Serializer. It should also explain how to use the plugin template to create an Exporter plugin. (The template will include unnecessary objects, like an Importer.)
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 Exporter Model, Viewset, and Serializer, then review the plugin template and its included objects. Document how to implement each exporter component and how to create an Exporter plugin with the template, including the unnecessary Importer objects.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100