Maintenance: Planio will be observing a scheduled maintenance window this Tuesday, November 5, 2024 from 03:00 UTC until 06:30 UTC to perform urgent network maintenance in our primary data center. Your Planio account will be unavailable during this maintenance window.
Actions
Refactor #2852
closedRefactor plugin section of the pulp3 documentation
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.
Actions
Refactor Plugins section in docs
closes #2852 https://pulp.plan.io/issues/2852