Project

Profile

Help

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
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

Actions

Also available in: Atom PDF