Task #3346: Add documentation for Exporter plugins - Pulp

Send by e-mail

Task #3346

Add documentation for Exporter plugins

Added by amacdona@redhat.com over 1 year ago. Updated 6 months ago.

Status:

NEW

Priority:

Normal

Assignee:

Category:

Sprint/Milestone:

Start date:

Due date:

% Done:

Platform Release:

Blocks Release:

Backwards Incompatible:

Groomed:

Yes

Sprint Candidate:

Tags:

Documentation

QA Contact:

Complexity:

Smash Test:

Verified:

Verification Required:

Sprint:

Description

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.)

Related issues