Bug #14419
Add clarity about direct editing process of docs.puppetlabs.com
| Status: | Closed | Start date: | 05/10/2012 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: |  Mike Hall | % Done: | 0% | |
| Category: | - | |||
| Target version: | - | |||
| Keywords: | Affected URL: | http://docs.puppetlabs.com/contribute.html | ||
| Branch: | ||||
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!)
Updated by