The IssueTrackingWikiProtocol is used for pages which are intended for tracking open and resolved issues. In order for this to work, we've created a few simple rules for modifying these pages.

The Rules

1. We keep two kinds of pages - OpenIssues[1] and ResolvedIssues[2]. Items are originally created on the OpenIssues[1] page, and then moved to the ResolvedIssues[2] page, once they've been resolved according to the originator of the issue.

2. All issues are numbered with a permanent number. The Wiki won't do this for us conveniently, so the following format is used 2). Parentheses are used to keep the wiki from autonumbering the paragraph. Every issue number should be accounted for between the OpenIssues[1] page and the ResolvedIssues[2] page.

3. The line with the issue number on it should contain only a short description of the issue, preferably one that fits on one line.
4. Subsequent lines are indented using a single space. Sometimes the issues are written in the voices of different participants. When the participant changes, the text should start in a new paragraph.
5. Spelling corrections and simple wording clarifications are fine. Feel free to make them inline.
6. Disagreements, comments, questions, and more verbose clarifications should be in separate paragraphs in most cases.
7. Both pages are kept in reverse cronological order. That is, the newest / most recently resolved issues are placed first on the respective pages.

Sample OpenIssues Page

1) LarsMarowskyBree[3] thinks we need some more documentation on Wiki etiquette

• AlanRobertson[4] isn't quite sure he understands what is wanted here.

2) AlanRobertson[4] thinks we need to have someplace in the Wiki to track open and closed issues for the LocalResourceManager[5].

Sample ResolvedIssues Page

1) LarsMarowskyBree[3] thinks we need some more documentation on Wiki etiquette

• AlanRobertson[4] isn't quite sure he understands what is wanted here.

  Eventually we created the WikiEtiquette[6] page.

2) AlanRobertson[4] thinks we need to have someplace in the Wiki to track open and closed issues for the LocalResourceManager[5].

• Eventually he creates the LocalResourceManagerOpenIssues[7] page, the LocalResourceManagerResolvedIssues[8] page, and the IssueTrackingWikiProtocol page to document the intended process.

---

Uhm, the examples above are not sorted in reverse order ... was this intentional?

And, may I suggest to use the Include macro instead, like in [[Include(BaseNameOpenIssues/IssueName)]]

This ways you have one subpage per issue, which stays the same and can even be bookmarked. The macro invocation then can easily be moved from the OpenIssues to the ResolvedIssues page.

• -lge[9]

See Also

WikiEtiquette[6]

---

This information provided courtesy of the Linux-HA project at http://linux-ha.org/