This Wiki is the old Xen Wiki, which is now read-only!
Please go to wiki.xen.org for the live version!
Xen 
 
Home Products Support Community Blog
 
   

The Docs Squad

Before you continue reading, join the wiki as a Wiki User.

Why we need YOU!

This Wiki has existed for some time and as with many Wiki's contains a lot of content that is out-of-date, or not relevant any more. We want to replace the Wiki with a new MediaWiki soon, but will need to migrate relevant and useful content to the new wiki.

UncleSamSmall

To do this, we need to know which documents are useful to YOU, which documents are wrong and then fix them. This is where YOU come in: with your help we can do this.

Help us

What the Squad will do!

The Docs Squad will:

  • Meet regularly meet on IRC (we can decide how often when we have critical mass)
  • Recognize the members for their contribution (I will try and figure out how to do this best, once we have a group of volunteers)
  • Review, assess, fix and migrate content to the new Wiki
  • Will be the key people who will decide what the new Wiki looks like and is managed

Sign up as a Volunteer!

Please list your Wiki username here and tell us which time zone you are in:

When we get going, turn up to the meetings to co-ordinate and discuss what we do and turn up!

Tagging Pages

We are trying to asses pages by two criteria:

  • In what state the page is in
    • Unsure : the page may need to be reviewed

    • Incorrect or incomplete : the page needs a rewrite

    • Badly structured, not needed, duplicating information : the page needs to be cleaned up

  • How useful is the page
    • Important : can't do without
    • Useful : this means that the page is useful to some people
    • Unimportant: the page is not that important
    • Obvsolete : the page is probably not needed any more

We tag pages using the above criteria. Feel free to add these tags to pages, when you come across an issue. We will use this information to decide which pages should be migrated and which ones should not.

Needs Review

[[NeedsReview(Important|Useful|Unimportant|Obvsolete page: Give some indication what to check for!)]]

Examples:

A review has been requested for this page

Important page: check whether section XXX is still valid!

A review has been requested for this page

Useful page: I tried ABC and it did not work; please check!

Needs Rewrite

[[NeedsRewrite(Important|Useful|Unimportant|Obvsolete page: Description of issue\improvement suggestion!)]]

Examples of tags:

A rewrite has been sugested for this page

Useful page: Section ABC is missing!

A rewrite has been sugested for this page

Obvsolete page: Most of the page seems to be out-of-date!

Needs Cleanup

[[NeedsCleanup(Important|Useful|Unimportant|Obvsolete page: Description of issue\improvement suggestion!)]]

Examples of tags:

A cleanup has been sugested for this page

Obvsolete page: Delete the page, as it appears not to be needed any more!

A cleanup has been sugested for this page

Useful page: This page duplicates some information in XYZ page; merge with XYZ!

Tagged Pages

Pages that Needs Review

Pages that Needs Rewrite

Pages that Needs Cleanup

XenDocsSquad (last edited 2011-10-14 22:54:52 by lars.kurth)

 
   
   
Citrix