Project

Profile

Help

Refactor #2852

Refactor plugin section of the pulp3 documentation

Added by bizhang over 3 years ago. Updated 12 months ago.

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

100%

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

Description

Based on the proposed doc structure [0] the Plugins section of the documentation should be reorganized like the following:

Landing Page

  • Brian's plugin table
  • Link to plugin writer's guide

Plugin_API Reference (autodoc)

Plugin Writer's Guide

  • Checklist
  • Writing your first plugin
  • Generating a CLI
  • Releasing your plugin

The Landing Page should contain a summary of what belongs in this section. Each separate page should be stubbed out.
The current Plugin_API section should be renamed to API_Reference and moved to the top level section of the pulp docs.

[0] http://pad-katello.rhcloud.com/p/pulp3_doc_structure

Associated revisions

Revision 25f4ef0f View on GitHub
Added by ttereshc over 3 years ago

Refactor Plugins section in docs

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

Revision 25f4ef0f View on GitHub
Added by ttereshc over 3 years ago

Refactor Plugins section in docs

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

Revision 2aa8032b View on GitHub
Added by ttereshc over 3 years ago

Add Plugins section, manage plugins/index.rst differently for Pulp 3

re #2852 https://pulp.plan.io/issues/2852

History

#1 Updated by bizhang over 3 years ago

  • Description updated (diff)

#2 Updated by amacdona@redhat.com over 3 years ago

  • Groomed changed from No to Yes

#3 Updated by amacdona@redhat.com over 3 years ago

  • Sprint/Milestone set to 41

#4 Updated by bizhang over 3 years ago

  • Tags Pulp 3 Plugin Writer Alpha added

#5 Updated by ttereshc over 3 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to ttereshc

#7 Updated by ttereshc over 3 years ago

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

#8 Updated by bmbouter almost 3 years ago

  • Tags deleted (Pulp 3 Plugin Writer Alpha)

#9 Updated by bmbouter over 2 years ago

  • Sprint set to Sprint 22

#10 Updated by bmbouter over 2 years ago

  • Sprint/Milestone deleted (41)

#11 Updated by daviddavis over 1 year ago

  • Sprint/Milestone set to 3.0.0

#12 Updated by bmbouter over 1 year ago

  • Tags deleted (Pulp 3)

#13 Updated by bmbouter 12 months ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF