Actions
Refactor #2851
closed
Refactor 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
Updated by amacdona@redhat.com almost 7 years ago
- Groomed changed from No to Yes
- Sprint Candidate changed from No to Yes
Updated by amacdona@redhat.com almost 7 years ago
- Status changed from NEW to ASSIGNED
- Assignee set to amacdona@redhat.com
Updated by jortel@redhat.com over 6 years ago
- Sprint/Milestone changed from 43 to 44
Updated by jortel@redhat.com over 6 years ago
- Sprint/Milestone changed from 45 to 46
Updated by jortel@redhat.com about 6 years ago
- Sprint/Milestone changed from 53 to 54
Updated by amacdona@redhat.com about 6 years ago
- Related to Task #3447: Document the differences between stories/tasks/issues added
Updated by jortel@redhat.com about 6 years ago
- Sprint changed from Sprint 33 to Sprint 34
Updated by daviddavis about 6 years ago
- Sprint changed from Sprint 34 to Sprint 35
Updated by amacdona@redhat.com about 6 years ago
- Status changed from ASSIGNED to POST
Added by amacdona@redhat.com almost 6 years ago
Added by amacdona@redhat.com almost 6 years ago
Revision cb90f2f2 | View on GitHub
(Re)write contributor documentation
Organizes documentation for nice flow for new users and contributors.
Updated by amacdona@redhat.com almost 6 years ago
- Status changed from POST to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulp|cb90f2f206bc2bd073c378aa812ef819f1c352f5.
Updated by bmbouter over 4 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Actions
.
(Re)write contributor documentation
Organizes documentation for nice flow for new users and contributors.
fixes #2851 https://pulp.plan.io/issues/2851