Project Types for TODO Tasks

Revision as of 17:50, 8 October 2013 by Mdean (talk | contribs) (Initial version.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Project Types

This page lists the different project types which need to be used to mark wiki pages. The project types go into a comma separated list after a project= in the TODO list tag.

Tag Format:

{{todo|Message|user_name|project=project1, project2, project3}}
This is the name of the plugin. Should always be todo
This is the note about the text. This is a plain-text, human readable comment.
This is the name of the user to which the page is assigned. For instance, mdean
project1, project2
These are the names of the projects to which the page belongs, as detailed below. The project= tag needs to always precede this list. If the project name has a space in it, just enter it into this list with the space intact. No quotes/etc. are needed.

Project Tags

These are the tags to use. The comments describe them.

Release Versions

The following list release versions for which a page is valid and for which it needs to be complete.

  • oe 4
  • oe 5

Engineer List

The following list contains the initials to use for assigning tasks to specific engineers:

  • KY - Klint Youngmeyer
  • MD - Michael Dean
  • MG - Michael Gloff
  • MW - Michael Welling
  • TS - Travis Stratman

Status Indicator Types

The following types are used to indicate the current status of a page. Only one of these tags should appear in the TODO tag of a page at any one time.

  • Review - Use this to indicate that the page needs to be reviewed.
  • FinalDraft - Use this to indicate that the page has been reviewed, and pending further comments, is ready to be marked complete.
  • Complete - Use this to indicate that the page has passed any scrutiny given after being marked FinalDraft. This should be done by the 2nd reviewer.
  • Deprecated - Use this to indicate that the information on the page is going to be invalidated by an upcoming release.
  • Obsolete - Use this to indicate that the information on the page is no longer valid for the current release; page is kept for reference for customers still using/maintaining an older image for which this page does apply.
  • Buggy - Use this to indicate that there are bugs in the content of the page.
  • Revise - Use this to indicate that the page needs to be revised, such as for an upcoming release.

NOTE: The difference between Buggy and Revise is that Buggy simply indicates that there have been bugs noticed, but no plan made to do anything about them, while Revise indicates that the page is marked to be revised. A new engineer, for example, may mark a page Buggy so that an experienced engineer can check before upgrading the type to Revise. This way, if the new engineer actually caught a bug in our release instead of in our documentation, the bug will be fixed in the correct place and the issue will be assigned to the correct person.