Project

Profile

Help

Task #2910

closed

Create a plugin writer's guide

Added by bizhang over 5 years ago. Updated over 2 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
Actions #1

Updated by bmbouter over 5 years ago

I will help groom this story.

Actions #2

Updated by bmbouter over 5 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.

Actions #3

Updated by mhrivnak over 5 years ago

  • Priority changed from Normal to Low
Actions #4

Updated by mhrivnak over 5 years ago

  • Sprint/Milestone set to 42
Actions #5

Updated by mhrivnak over 5 years ago

  • Sprint/Milestone changed from 42 to 43
Actions #6

Updated by mhrivnak over 5 years ago

  • Priority changed from Low to High
Actions #7

Updated by jortel@redhat.com over 5 years ago

  • Sprint/Milestone changed from 43 to 44
Actions #8

Updated by ttereshc about 5 years ago

  • Description updated (diff)
  • Assignee set to ttereshc
Actions #9

Updated by ttereshc about 5 years ago

  • Status changed from NEW to ASSIGNED

Added by ttereshc about 5 years ago

Revision d4743e82

Add docs for plugin writers

closes #2910 https://pulp.plan.io/issues/2910

Added by ttereshc about 5 years ago

Revision d4743e82

Add docs for plugin writers

closes #2910 https://pulp.plan.io/issues/2910

Actions #10

Updated by ttereshc about 5 years ago

  • Status changed from ASSIGNED to MODIFIED
  • % Done changed from 0 to 100
Actions #11

Updated by bmbouter almost 5 years ago

  • Tags deleted (Pulp 3 Plugin Writer Alpha)
Actions #12

Updated by bmbouter over 4 years ago

  • Sprint set to Sprint 25
Actions #13

Updated by bmbouter over 4 years ago

  • Sprint/Milestone deleted (44)
Actions #14

Updated by daviddavis over 3 years ago

  • Sprint/Milestone set to 3.0.0
Actions #15

Updated by bmbouter over 3 years ago

  • Tags deleted (Pulp 3)
Actions #16

Updated by bmbouter almost 3 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF