Actions
Refactor #2851
closedRefactor contributing section in the pulp3 documentation
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 35
Quarter:
Description
Based on the proposed doc structure [0] the Contributing section of the documentation should be reorganized like the following:
Landing Page
- Contributing Guide Checklist
Dev Setup
Contributing Guide
- Patches
- Branching
- Git
- GitHub
- Merging
- Code Review
Code Guidelines
- Python Version
- PEP-8
- Docstring
- Encoding
- Exception handling
How to Write Documentation
How to Write Tests
Pulp Processes
- link to PUPs
Code architecture and tools
- Code layout
- DRF information
- Django Information
The Landing Page should contain a summary of what belongs in this section. Each separate page should be stubbed out.
Related issues
Actions
(Re)write contributor documentation
Organizes documentation for nice flow for new users and contributors.
fixes #2851 https://pulp.plan.io/issues/2851