Project

Profile

Help

Task #731

closed

Redmine docs fixes

Added by bmbouter about 9 years ago. Updated about 5 years ago.

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

100%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Pulp 2
Sprint:
March 2015
Quarter:

Description

A base level of updating was done to the the 2.5, 2.6, and master docs when we switched to Redmine. There are still some things that need to be done to get the docs fully aligned with Redmine.

Deliverables:

  • All projects (platform, rpm, puppet, docker, etc) all have a conf.py which contains extlinks and a way to easy-link to a Bugzilla bug from the docs. We need remove the bugzilla specific bug and bugs in a release with redmine extlinks.
  • Update all usages of extlinks to use either the new style (if its in redmine) or unroll the link manually since they will no longer work with the new exlinks.
  • Search through the docs for all projects and check to see if there are links into Bugzilla that need to be updated. If the bug was closed in Bugzilla with CLOSED UPSTREAM then update it with the extlinks reference to Redmine from above.
  • Go through the contributing section of the dev guides to look for documentation that doesn't match our current Redmine process. For example the traiging docs are out of date with the use of keywords.

Also available in: Atom PDF