The Puppet Labs Issue Tracker has Moved: https://tickets.puppetlabs.com

Bug #14419

Add clarity about direct editing process of docs.puppetlabs.com

Added by Philip Brown about 2 years ago. Updated over 1 year ago.

Status:ClosedStart date:05/10/2012
Priority:NormalDue date:
Assignee:Mike Hall% Done:

0%

Category:-
Target version:-
Keywords: Affected URL:http://docs.puppetlabs.com/contribute.html
Branch:

We've Moved!

Ticket tracking is now hosted in JIRA: https://tickets.puppetlabs.com

This issue is currently not available for export. If you are experiencing the issue described below, please file a new ticket in JIRA. Once a new ticket has been created, please add a link to it that points back to this Redmine ticket.


Description

The referenced URL doesnt make the nature of the “edit it yourself” method clear. There is also a step or two that is out of order, chronologically speaking.

The following changes should help.

First, create a new section, “Preview your changes”, below the “Make your edits” section. It should contain wording similar to the following:

“Viewing the results of your edits in the same way they will appear on the website, is done by running a local document server process on your own computer. This is a ruby process, the code for which is contained in the git documentation tree. Full details on this can be found the the following links. ”

Secondly, move the two links relevant to that process, from under the “Learn How to Write Puppet Documentation”, into the new section. However, leave the “documentation style and usage guide” link in that section.(but fix the broken link!)

History

#1 Updated by Mike Hall almost 2 years ago

  • Status changed from Unreviewed to Investigating
  • Assignee set to Mike Hall

#2 Updated by Mike Hall over 1 year ago

  • Status changed from Investigating to Closed

Also available in: Atom PDF