Project

Profile

Help

Task #2910

closed

Create a plugin writer's guide

Added by bizhang over 6 years ago. Updated over 3 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
High
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation
Sprint:
Sprint 25
Quarter:

Description

This guide exists as a stub under pulp/docs/plugins
It needs to be fleshed out as a comprehensive guide for the first time pulp plugin writer.

This guide should include:

  • A Plugin Completeness Checklist
  • Writing your first plugin
  • Pulp Plugin Basics
  • a plugin is a django app
  • what is the recommended layout of a plugin
  • how pulp does plugin viewset, serializer discovery
  • what is the entrypoint
  • what importer, publish, sync does and how they to implement them
  • Documentation
  • how to host your docs on docs.pulpproject.org
  • Error Handling
  • Generating a CLI
  • Releasing your plugin

Also available in: Atom PDF