Project

Profile

Help

Task #2910

Create a plugin writer's guide

Added by bizhang over 2 years ago. Updated 6 months ago.

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

100%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 25

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

Associated revisions

History

#1 Updated by bmbouter over 2 years ago

I will help groom this story.

#2 Updated by bmbouter over 2 years ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes

This story looks good; it's the same content from when we met about the structure. Thanks for filing.

#3 Updated by mhrivnak about 2 years ago

  • Priority changed from Normal to Low

#4 Updated by mhrivnak about 2 years ago

  • Sprint/Milestone set to 42

#5 Updated by mhrivnak about 2 years ago

  • Sprint/Milestone changed from 42 to 43

#6 Updated by mhrivnak about 2 years ago

  • Priority changed from Low to High

#7 Updated by jortel@redhat.com about 2 years ago

  • Sprint/Milestone changed from 43 to 44

#8 Updated by ttereshc about 2 years ago

  • Description updated (diff)
  • Assignee set to ttereshc

#9 Updated by ttereshc about 2 years ago

  • Status changed from NEW to ASSIGNED

#10 Updated by ttereshc about 2 years ago

  • Status changed from ASSIGNED to MODIFIED
  • % Done changed from 0 to 100

#11 Updated by bmbouter almost 2 years ago

  • Tags deleted (Pulp 3 Plugin Writer Alpha)

#12 Updated by bmbouter over 1 year ago

  • Sprint set to Sprint 25

#13 Updated by bmbouter over 1 year ago

  • Sprint/Milestone deleted (44)

#14 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#15 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF