Help:Wiki Community: Difference between revisions

From Xen
Jump to navigationJump to search
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Before you continue reading, join the wiki as a user. We do not require for you to do this, but encourage you to register.
Before you continue reading, [[Special:UserLogin|join the wiki as a user]]. We do not require for you to do this, but encourage you to register.
__TOC__

{| border="0" valign="top" cellpadding="2" cellspacing="0"
{| border="0" valign="top" cellpadding="2" cellspacing="0"
|
|
Line 8: Line 8:
* Recognize community members for their contributions
* Recognize community members for their contributions
* Make new Wiki much more manageable by using Categories and other proven Wiki tools
* Make new Wiki much more manageable by using Categories and other proven Wiki tools
* Help migrate pages from the old Wiki: [[Wiki Community/Migration Instructions from Old to New Xen Wiki|Migration Instructions from Old to New Xen Wiki]]
|http://www.xen.org/images/blog/UncleSamSmall.png
|http://www.xen.org/images/blog/UncleSamSmall.png
|}
|}


= Wiki Conventions =
= Wiki Conventions =
We want to make it as wasy as possible for users to use and find content in the new Wiki and also ensure that the Wiki remains up-to-ate.
We want to make it as easy as possible for users to use and find content in the new Wiki and also ensure that the Wiki remains up-to-date.

== Templates ==
The Xen wiki provides a number of templates. Templates are normally documented. You can find the most commonly used templates and their documentation at [[:Category:Templates|Category:Templates]].


== Useful Built-in Wiki Pages ==
== Useful Built-in Wiki Pages ==
Line 31: Line 35:
|
|
|[[Special:WantedCategories|Wanted Categories]] »» Create category
|[[Special:WantedCategories|Wanted Categories]] »» Create category
|[[:Category:Contains_TODO|TODO Item]] »» Contains TODO item
|[[:Category:Contains_Needs_Formatting|Needs formatting]] »» Easy fix for a beginner
|-
|-
|
|
|[[Special:WantedTemplates|Wanted Templates]] »» Create template
|[[Special:WantedTemplates|Wanted Templates]] »» Create template
|[[:Category:Contains_TODO|TODO Item]] »» Contains TODO item
|}
|}


{{Anchor|templates}}
== Managing Pages via Templates ==
== Managing Pages via Templates ==
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
Line 78: Line 84:
|[[:Template:Info]]
|[[:Template:Info]]
|This is a generic info box, which highlights some information about this page.
|This is a generic info box, which highlights some information about this page.
|-
|[[:Template:InfoLeft]]
|Same as '''Info''' only that not centered
|-
|-
|[[:Template:Warning]]
|[[:Template:Warning]]
Line 88: Line 97:
* Another example: <pre>{{Needs_Archive|This page is out-of-date: this project completed in 2009.}}</pre>
* Another example: <pre>{{Needs_Archive|This page is out-of-date: this project completed in 2009.}}</pre>


== Improving Navigation through Categories ==
== Categories ==
{{Anchor|categories}}
=== Common Categories ===
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by audience'''''
|-
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
|-
|[[:Category:Users]]
|This document is for users of Xen or any project hosted on Xen.org
|-
|[[:Category:Beginners]]
|This document is primarily targetted at beginners. Note that this category should primarily be used together with [[:Category:Users]].
|-
|[[:Category:Developers]]
|This document is for developers of Xen or any project hosted on Xen.org
|-
|[[:Category:Project]]
|This document is primarily a project document such as a roadmap, TODO lis, minutes, etc. for a project hosted on Xen.org
|-
|[[:Category:Community]]
|This document is a community document that doesn't fit elsewhere. It is intended for general information of Xen and the community at large
|-
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by lifetime'''''
|-
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
|-
|[[:Category:Transient]]
|This document has a limited lifespan (e.g. it describes an event or a short-lived activity). Pages in this category should be reviewed at least annually and archived appropriately.
|-
|[[:Category:Archived]]
|This document has been archived.
|-
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by document type''''' (note that these should be used in conjunction with audience categories)
|-
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
|-
|[[:Category:Overview]]
|This document contains an Overview document for a specific topic. Overviews are typically introductory and contain definitions, trade-offs, basic concepts, etc.
|-
|[[:Category:FAQ]]
|This document contains one or several frequently asked questions including answers
|-
|[[:Category:HowTo]]
|This document contains a HowTo document, which usually is a short tutorial
|-
|[[:Category:Tutorial]]
|This document contains a step-by-step tutorial for a fairly complex use-case
|-
|[[:Category:Example]]
|This document primarily contains example configuration files, settings, scripts, etc.
|-
|[[:Category:Compatibility]]
|This document contains a information about software - software, software - hardware and other compatibility.
|-
|[[:Category:Index]]
|This document is largely an index to other pages.
|-
|[[:Category:Glossary]]
|This document is a definition of a term used in the Xen community or more generally.
|-
|colspan="2" style="background-color:#38A3C7;"| '''''Categories by project or technology'''''
|-
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
|-
|[[:Category:Xen]]
|This document is related to the Xen Hypervisor project or technology. This category may be used for user, developer as well as project categories.
|-
|[[:Category:XCP]]
|This document is related to the XCP project or technology. This category may be used for user, developer as well as project categories.
|-
|[[:Category:PVOPS]]
|This document is related to the PVOPS project or technology, which is about upstreaming and maintining Xen support in Linux. This category may be used for user, developer as well as project categories.
|-
|[[:Category:XenARM]]
|This document is related to the XenARM project or technology. This category may be used for user, developer as well as project categories.
|}


We use categories to help manage Wiki pages:
=== Other Categories ===
* Each Wiki page should be at least in one category
These are more specialised categories. Please ensure that these are used in conjunction with
* Our category pages are not normally just indexes, but have a hand-edited header, which highlight important information.
{|style="vertical-align: top; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"

|colspan="2" style="background-color:#38A3C7;"| '''''Project type: Categories that relate to a specific [[:Category:Project|project]]'''''
== Creating new pages ==
|-
* Please make sure that you choose '''ONE''' of the following categories on a new page
|style="width: 20%;background-color:#58D3F7;"|'''Category'''
** '''Technology''': Xen, XCP, XenARM, PVOPS
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
** '''Audience''': Beginners, Users, Developers,Project, Community
|-
** '''Documentation Type''': Manual, Overview, FAQ, HowTo, Tutorial, Example, Compatibility, Glossary, Index (pick what fits best)
|[[:Category:OCaml]]
** '''Life span''': choose category Transient if the document is transient (e.g. describes an event)
|This document is related to the [http://en.wikipedia.org/wiki/OCaml OCaml] language, in which most of XCP is implemented.
** '''External''': choose category RefToExternalArticle if the is a stub linking to an external article
|-
* For other categories, please check [[Categories for Authors]] for more detail
|colspan="2" style="background-color:#38A3C7;"| '''''Document type: Categories that are mainly relevant to [[:Category:Developers|developers]]'''''
* If your article is important, please go to the most relevant category and add the article to the hand-maintained content
|-
* '''Help on categories''': [[mediawikiwiki:Help:Categories|Help:Categories]]
|style="width: 20%;background-color:#58D3F7;"|'''Category'''

|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
== Creating a new Category ==
|-
* Please do NOT just create an empty category
|[[:Category:Development Process]]
* Add content the top the category: examples are [[:Category:Host_Install]] and [[:Category:Arch_Linux]]
|This document describes a process or technique relates to projects on Xen.org. Documents in this category are mainly relevant for developers.
* Please describe the new category in
|-
** [[Categories for Users]]
|[[:Category:Design Document]]
** [[Categories for Authors]]
|This category contains design documents, architecture descriptions, and so on: in short it contains documents that describe how parts of the codebase work. Documents in this category are mainly relevant for developers.

|-
== Improving Accessibility of topics with Trails ==
|colspan="2" style="background-color:#38A3C7;"| '''''Document type: Categories that are mainly relevant to [[:Category:Users|users]]'''''
Trails are sequences of documents (or indeed sections of documents) that are suggested to be read in a certain order. Note that trails are automatically added to the [[:Category:Trail]].
|-

|style="width: 20%;background-color:#58D3F7;"|'''Category'''
{{Trailbox||Trails_Usage
|style="width: 80%;background-color:#58D3F7;"|'''When to use'''
|{{Trail|Usage of Trails|
|-
* [[Template:Trailbox#Usage|Trailbox Syntax]]
|[[:Category:Release Notes]]
* [[Template:Trail#Usage|Trail Syntax]]
|This document describes Release Notes for a specifc project or product hosted on Xen.org.
* [[Template:Trail#Trailbox_Trail_Example|Using both templates together]]
|}
}}
}}

{{Anchor|archive}}

== Archiving Pages ==
Pages are archived in the following way:
* Add [[[[:Category:Archived|Category:Archived]]]] to the page
* Rename the page from '''<pagename>''' to '''Archived/<pagename>'''
** If you do not have the right to rename pages, add [[[[Template:Needs_Archive]]]] to the page
* Ensure you do the same with all sub-pages and translations
* Keep all categories as they are
* If you cannot rename the page, then mark it with '''<nowiki>{{Needs_Archive|Reason why}}</nowiki>''', such that a wiki adminstrator can rename the page

= Multi-language Help and Conventions =
For more information, see [[Xen:Multi-language Conventions|Multi-language Conventions]]
{{Anchor|Talk}}


= Use of Discussions: Talk pages =
= Use of Discussions: Talk pages =
Line 209: Line 157:
* Talk pages are good in particular, if you suspect something is wrong with the content, but you do not quite know how to fix the page.
* Talk pages are good in particular, if you suspect something is wrong with the content, but you do not quite know how to fix the page.
'''Conventions''':
'''Conventions''':
* Always use the {{tl|comment}} template using <code><nowiki>{{Comment|~~~~:}} your comment text</nowiki></code> for commenting. Using the template makes it easier to find and address any comments made on talk pages. If you do not use this notation, your comment may be lost if it is not addressed immediately. Note that <code><nowiki>~~~~</nowiki></code> will render to something like <code><nowiki>[[User:Example|Simon Brown]] 21:55, 3 September 1991 (UTC)</nowiki></code>
* Start a new discussion with a ==level 2 heading== at the bottom of the page (or use the “+” tab)
* Start a new discussion with a <code><nowiki>==level 2 heading==</nowiki></code> at the bottom of the page (or use the “{{lcfirst:{{int:addsection}}}}” tab).
* Always sign your name after your comments. Use the four tildes “<code><nowiki>~~~~</nowiki></code>” wiki syntax (or the signature button [[File:button_sig.png|text-bottom|link=|signature button]] in the toolbar above the editing textbox). For more information see Help:Signatures.
* Indent replies with colons (:) at the beginning of the line.
* Indent replies with colons (<code>:</code>) at the beginning of the line.




'''Also See''':
'''Also See''':
* [http://www.mediawiki.org/wiki/Help:Talk_pages Help on Talk Pages]
* [[Help:Talk Pages|More on Talk Pages (examples, etc.)]]


[[Category:Index]]
[[Category:Index]]
[[Category:Wiki Management]]
[[Category:Community]]
[[Category:Community]]
{{Languages}}

Latest revision as of 09:52, 7 June 2013

Before you continue reading, join the wiki as a user. We do not require for you to do this, but encourage you to register.

Why we need YOU!

The Xen.org 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 decided to migrate to a new MediaWiki based wiki, which allows us a fresh start. We hope to be able to mobilize Xen community members and are planning a number of regular activities and approaches:

  • Regular Document Days on IRC
  • Recognize community members for their contributions
  • Make new Wiki much more manageable by using Categories and other proven Wiki tools
  • Help migrate pages from the old Wiki: Migration Instructions from Old to New Xen Wiki
 UncleSamSmall.png

Wiki Conventions

We want to make it as easy as possible for users to use and find content in the new Wiki and also ensure that the Wiki remains up-to-date.

Templates

The Xen wiki provides a number of templates. Templates are normally documented. You can find the most commonly used templates and their documentation at Category:Templates.

Useful Built-in Wiki Pages

These pages will help editors spot pages that need work.

Changes Missing Content Manage Pages
Recent Changes Wanted Pages »» Create page Uncategorized Pages »» Categorize
Related Changes Wanted Files »» Upload file Action Needed »» Needs deletion, refactor, review, ...
Wanted Categories »» Create category Needs formatting »» Easy fix for a beginner
Wanted Templates »» Create template TODO Item »» Contains TODO item

Managing Pages via Templates

Templates to help manage content
Template When to use
Template:Needs_Archive Indicates that this page needs to be archived. Please specify a reason why.
Template:Needs_Additions Indicates that this page is incomplete and can benefit from additions and improvements. Please specify what should be added.
Template:Needs_Delete Indicates that this page needs to be deleted. Please specify a reason why.
Template:Needs_Formatting Indicates that this page has some formatting issues. Please detail the issue.
Template:Needs_Refactor Indicates that this page needs to be refactored, such as merging or splitting. Please be concrete about the reason and proposed ocurse of action.
Template:Needs_Review Indicates that this page needs to be reviewed. If specific parts of the page need reviewing or are incorrect, please state in the macro.
Template:Needs_Rewrite Indicates that this page needs to be rewritten; in other words it is useful but contains lots of errors. Please provide more information in the macro.
Template:Needs_Recategorize Indicates that this page needs to be properly categorized. Please specify a reason why.
Template:TODO This is a generic template that indicates that something needs to be done to this page. Should only be used if the more specific templates are not applicable.
Other more generic templates
Template When to use
Template:Info This is a generic info box, which highlights some information about this page.
Template:InfoLeft Same as Info only that not centered
Template:Warning This is a generic warning box, which highlights some information about this page that typically warns the user of something.

Also see:

  • Help on Templates
  • Example on how to use any of the above templates: 
    {{Info|This is an infobox with this text in the box}}
  • Another example: 
    {{Needs_Archive|This page is out-of-date: this project completed in 2009.}}

Categories

We use categories to help manage Wiki pages:

  • Each Wiki page should be at least in one category
  • Our category pages are not normally just indexes, but have a hand-edited header, which highlight important information.

Creating new pages

  • Please make sure that you choose ONE of the following categories on a new page
    • Technology: Xen, XCP, XenARM, PVOPS
    • Audience: Beginners, Users, Developers,Project, Community
    • Documentation Type: Manual, Overview, FAQ, HowTo, Tutorial, Example, Compatibility, Glossary, Index (pick what fits best)
    • Life span: choose category Transient if the document is transient (e.g. describes an event)
    • External: choose category RefToExternalArticle if the is a stub linking to an external article
  • For other categories, please check Categories for Authors for more detail
  • If your article is important, please go to the most relevant category and add the article to the hand-maintained content
  • Help on categories: Help:Categories

Creating a new Category

Improving Accessibility of topics with Trails

Trails are sequences of documents (or indeed sections of documents) that are suggested to be read in a certain order. Note that trails are automatically added to the Category:Trail.

Usage of Trails

Archiving Pages

Pages are archived in the following way:

  • Add [[Category:Archived]] to the page
  • Rename the page from <pagename> to Archived/<pagename>
  • Ensure you do the same with all sub-pages and translations
  • Keep all categories as they are
  • If you cannot rename the page, then mark it with {{Needs_Archive|Reason why}}, such that a wiki adminstrator can rename the page

Multi-language Help and Conventions

For more information, see Multi-language Conventions

Use of Discussions: Talk pages

Every wiki page has an associated talk page which can be used for discussion and communicating with other users. Talk pages can be accessed by clicking the “discussion” tab at the top of the page. Simply edit the page as normal to add your comment.

We encourage the use of talk pages. However, it would be good if you followed these Guidelines What to discuss:

  • Keep focused on the task of building a wiki article: remember that editing the article itself is often a more effective means of communicating.
  • Use discussion pages only to support this process: the topic of conversation should generally revolve around what needs to be done to make the associated article better.
  • Talk pages are good in particular, if you suspect something is wrong with the content, but you do not quite know how to fix the page.

Conventions:

  • Always use the {{comment}} template using {{Comment|~~~~:}} your comment text for commenting. Using the template makes it easier to find and address any comments made on talk pages. If you do not use this notation, your comment may be lost if it is not addressed immediately. Note that ~~~~ will render to something like [[User:Example|Simon Brown]] 21:55, 3 September 1991 (UTC)
  • Start a new discussion with a ==level 2 heading== at the bottom of the page (or use the “+” tab).
  • Indent replies with colons (:) at the beginning of the line.


Also See:

Languages Language: English
Retrieved from "https://wiki.xenproject.org/index.php?title=Help:Wiki_Community&oldid=8633"