Project

Profile

Help

Actions
Send by e-mail Copy link

Refactor #2851

closed

Refactor contributing section in the pulp3 documentation

Added by bizhang over 7 years ago. Updated almost 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
amacdona@redhat.com
Category:
-
Sprint/Milestone:
3.0.0
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

Actions
Actions
Copy link
 #1

Updated by amacdona@redhat.com over 7 years ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes
Actions
Copy link
 #2

Updated by amacdona@redhat.com over 7 years ago

  • Sprint/Milestone set to 41
Actions
Copy link
 #3

Updated by amacdona@redhat.com over 7 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to amacdona@redhat.com
Actions
Copy link
 #4

Updated by mhrivnak over 7 years ago

  • Sprint/Milestone changed from 41 to 42
Actions
Copy link
 #5

Updated by mhrivnak over 7 years ago

  • Sprint/Milestone changed from 42 to 43
Actions
Copy link
 #6

Updated by jortel@redhat.com about 7 years ago

  • Sprint/Milestone changed from 43 to 44
Actions
Copy link
 #7

Updated by mhrivnak about 7 years ago

  • Sprint/Milestone changed from 44 to 45
Actions
Copy link
 #8

Updated by jortel@redhat.com about 7 years ago

  • Sprint/Milestone changed from 45 to 46
Actions
Copy link
 #9

Updated by mhrivnak about 7 years ago

  • Sprint/Milestone changed from 46 to 47
Actions
Copy link
 #10

Updated by rchan almost 7 years ago

  • Sprint/Milestone changed from 47 to 48
Actions
Copy link
 #11

Updated by daviddavis almost 7 years ago

  • Tags Pulp 3 MVP added
Actions
Copy link
 #12

Updated by rchan almost 7 years ago

  • Sprint/Milestone changed from 48 to 52
Actions
Copy link
 #13

Updated by rchan almost 7 years ago

  • Sprint/Milestone changed from 52 to 53
Actions
Copy link
 #14

Updated by jortel@redhat.com almost 7 years ago

  • Sprint/Milestone changed from 53 to 54
Actions
Copy link
 #15

Updated by rchan over 6 years ago

  • Sprint/Milestone changed from 54 to 56
Actions
Copy link
 #16

Updated by bmbouter over 6 years ago

  • Sprint set to Sprint 33
Actions
Copy link
 #17

Updated by bmbouter over 6 years ago

  • Sprint/Milestone deleted (56)
Actions
Copy link
 #18

Updated by amacdona@redhat.com over 6 years ago

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

Updated by jortel@redhat.com over 6 years ago

  • Sprint changed from Sprint 33 to Sprint 34
Actions
Copy link
 #20

Updated by daviddavis over 6 years ago

  • Sprint changed from Sprint 34 to Sprint 35
Actions
Copy link
 #21

Updated by amacdona@redhat.com over 6 years ago

  • Status changed from ASSIGNED to POST
Actions
Copy link
 #22

Updated by dkliban@redhat.com over 6 years ago

  • Sprint/Milestone set to 3.0.0

Added by amacdona@redhat.com over 6 years ago

Revision cb90f2f2 | View on GitHub

(Re)write contributor documentation

Organizes documentation for nice flow for new users and contributors.

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

Added by amacdona@redhat.com over 6 years ago

Revision cb90f2f2 | View on GitHub

(Re)write contributor documentation

Organizes documentation for nice flow for new users and contributors.

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

Actions
Copy link
 #23

Updated by amacdona@redhat.com over 6 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100
Actions
Copy link
 #24

Updated by bmbouter over 5 years ago

  • Tags deleted (Pulp 3, Pulp 3 MVP)
Actions
Copy link
 #25

Updated by bmbouter almost 5 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Actions
Send by e-mail Copy link

Also available in: Atom PDF