Project

Profile

Help

Refactor #2851

Refactor contributing section in the pulp3 documentation

Added by bizhang over 3 years ago. Updated about 1 year ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
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.

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


Related issues

Related to Pulp - Task #3447: Document the differences between stories/tasks/issuesCLOSED - WONTFIX

<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>

Associated revisions

Revision cb90f2f2 View on GitHub
Added by amacdona@redhat.com almost 3 years ago

(Re)write contributor documentation

Organizes documentation for nice flow for new users and contributors.

fixes #2851 https://pulp.plan.io/issues/2851

Revision cb90f2f2 View on GitHub
Added by amacdona@redhat.com almost 3 years ago

(Re)write contributor documentation

Organizes documentation for nice flow for new users and contributors.

fixes #2851 https://pulp.plan.io/issues/2851

History

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

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes

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

  • Sprint/Milestone set to 41

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

  • Status changed from NEW to ASSIGNED
  • Assignee set to amacdona@redhat.com

#4 Updated by mhrivnak over 3 years ago

  • Sprint/Milestone changed from 41 to 42

#5 Updated by mhrivnak over 3 years ago

  • Sprint/Milestone changed from 42 to 43

#6 Updated by jortel@redhat.com over 3 years ago

  • Sprint/Milestone changed from 43 to 44

#7 Updated by mhrivnak over 3 years ago

  • Sprint/Milestone changed from 44 to 45

#8 Updated by jortel@redhat.com over 3 years ago

  • Sprint/Milestone changed from 45 to 46

#9 Updated by mhrivnak about 3 years ago

  • Sprint/Milestone changed from 46 to 47

#10 Updated by rchan about 3 years ago

  • Sprint/Milestone changed from 47 to 48

#11 Updated by daviddavis about 3 years ago

  • Tags Pulp 3 MVP added

#12 Updated by rchan about 3 years ago

  • Sprint/Milestone changed from 48 to 52

#13 Updated by rchan about 3 years ago

  • Sprint/Milestone changed from 52 to 53

#14 Updated by jortel@redhat.com almost 3 years ago

  • Sprint/Milestone changed from 53 to 54

#15 Updated by rchan almost 3 years ago

  • Sprint/Milestone changed from 54 to 56

#16 Updated by bmbouter almost 3 years ago

  • Sprint set to Sprint 33

#17 Updated by bmbouter almost 3 years ago

  • Sprint/Milestone deleted (56)

#18 Updated by amacdona@redhat.com almost 3 years ago

  • Related to Task #3447: Document the differences between stories/tasks/issues added

#19 Updated by jortel@redhat.com almost 3 years ago

  • Sprint changed from Sprint 33 to Sprint 34

#20 Updated by daviddavis almost 3 years ago

  • Sprint changed from Sprint 34 to Sprint 35

#21 Updated by amacdona@redhat.com almost 3 years ago

  • Status changed from ASSIGNED to POST

#22 Updated by dkliban@redhat.com almost 3 years ago

  • Sprint/Milestone set to 3.0.0

#23 Updated by amacdona@redhat.com almost 3 years ago

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

#24 Updated by bmbouter over 1 year ago

  • Tags deleted (Pulp 3, Pulp 3 MVP)

#25 Updated by bmbouter about 1 year ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF