Project

Profile

Help

Refactor #7211

Refactor the documentation

Added by quba42 3 months ago. Updated about 2 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
-
Sprint/Milestone:
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.


Checklist

Associated revisions

Revision 53cf511c View on GitHub
Added by quba42 3 months ago

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.

History

#1 Updated by quba42 3 months ago

Note I have already started working on this.

#2 Updated by quba42 3 months ago

  • Checklist item Ensure all code blocks use consistent indentation. added

#3 Updated by quba42 3 months ago

  • Checklist item Make all title underlines 80 characters. set to Done

#4 Updated by quba42 3 months ago

  • Checklist item Use one sentence per line source text (not justified paragraphs) set to Done

#5 Updated by quba42 3 months ago

  • Checklist item Reference all URL's rather than embed them directly in text set to Done

#6 Updated by quba42 3 months ago

  • Checklist item Ensure all code blocks use consistent indentation. set to Done

#7 Updated by quba42 3 months ago

  • Checklist item Make all titles use sentence case (currently completly inconsistent) set to Done

#8 Updated by pulpbot 3 months ago

  • Status changed from NEW to POST

#9 Updated by quba42 3 months ago

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

#10 Updated by quba42 about 2 months ago

  • Sprint/Milestone set to 2.6.0b1

Please register to edit this issue

Also available in: Atom PDF