Project

Profile

Help

Refactor #2852

closed

Refactor plugin section of the pulp3 documentation

Added by bizhang over 6 years ago. Updated over 4 years 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

Also available in: Atom PDF