Project

Profile

Help

Actions
Send by e-mail Copy link

Refactor #7211

closed

Refactor the documentation

Added by quba42 over 4 years ago. Updated over 3 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
-
Sprint/Milestone:
2.6.0b1
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Target Release - Debian:
Groomed:
No
Sprint Candidate:
No
Tags:
Sprint:
Quarter:

Description

This is arguably me enforcing my preferred reStructuredText source conventions, but if I am to maintain the docs I need this for my sannity.

See the checklist for more information on the proposed changes.

Note that other than making titles use consistent case, this change should not cause any visible changes in the built documentation.

Actions
Copy link
 #1

Updated by quba42 over 4 years ago

Note I have already started working on this.

Actions
Copy link
 #2

Updated by quba42 over 4 years ago

Actions
Copy link
 #3

Updated by quba42 over 4 years ago

Actions
Copy link
 #4

Updated by quba42 over 4 years ago

Actions
Copy link
 #5

Updated by quba42 over 4 years ago

Actions
Copy link
 #6

Updated by quba42 over 4 years ago

Actions
Copy link
 #7

Updated by quba42 over 4 years ago

Actions
Copy link
 #8

Updated by pulpbot over 4 years ago

  • Status changed from NEW to POST

Added by quba42 over 4 years ago

Revision 53cf511c | View on GitHub

Refactor the entire documentation

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

  • Make all titles use title case (visible change).
  • Make all title underlines 80 characters long.
  • Make source files use one sentence per line.
  • Rechecked all URLs for broken links.
  • Use references for URLs embedded in text.
  • Use include statements to avoid duplicate source code.
  • Ensure consistent (3 space) ReStructuredText style indentation.
Actions
Copy link
 #9

Updated by quba42 over 4 years ago

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

Updated by quba42 over 4 years ago

  • Sprint/Milestone set to 2.6.0b1
Actions
Copy link
 #11

Updated by quba42 over 3 years ago

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

Also available in: Atom PDF