The Mer Wiki now uses your Mer user account and password (create account on https://bugs.merproject.org/)
About category guidelines
(use About - makes more sense - and hide the editing guidelines from casual browsing) |
(expand explanation of what this About system provides) |
||
| Line 1: | Line 1: | ||
| − | + | The [[:Category:About|'About' category]] is used to group concept pages together. | |
| − | + | 'About' categories are used in three ways: | |
; Belongs to | ; Belongs to | ||
: A page belongs to an About category to indicate that it provides a '''substantial''' amount of useful information about a concept; usually the concept is the primary subject of the page. | : A page belongs to an About category to indicate that it provides a '''substantial''' amount of useful information about a concept; usually the concept is the primary subject of the page. | ||
; Links to | ; Links to | ||
| − | : A page links to category to provide a useful reference for more information; typically <nowiki>"see the section [[:Category:concept|about concept]]"</nowiki>. (Notice the : between "[[" and "Category") | + | : A page links to a category page to provide a useful reference for more information; typically <nowiki>"see the section [[:Category:concept|about concept]]"</nowiki>. (Notice the : between "[[" and "Category") |
| + | ; Authority | ||
| + | : The category page for a concept should be authoritative for Mer - if it points to or provides bad information, that's a major bug. | ||
= Guidelines = | = Guidelines = | ||
== Creation == | == Creation == | ||
| − | Create a normal Category page and add <nowiki>[[Category:About]]</nowiki> at the bottom to ensure it is visible from the [[:Category:About]] page as well as the [[:Special:Categories]] page. | + | Create a normal Category page and add <nowiki>[[Category:About]]</nowiki> at the bottom to ensure it is visible from the [[:Category:About]] page as well as the [[:Special:Categories]] page. Think carefully if you should be creating a new category. |
| + | |||
== Usage == | == Usage == | ||
These pages can be referred to 'inline' in other wiki pages to avoid repetition. | These pages can be referred to 'inline' in other wiki pages to avoid repetition. | ||
Revision as of 10:59, 19 January 2012
The 'About' category is used to group concept pages together.
'About' categories are used in three ways:
- Belongs to
- A page belongs to an About category to indicate that it provides a substantial amount of useful information about a concept; usually the concept is the primary subject of the page.
- Links to
- A page links to a category page to provide a useful reference for more information; typically "see the section [[:Category:concept|about concept]]". (Notice the : between "[[" and "Category")
- Authority
- The category page for a concept should be authoritative for Mer - if it points to or provides bad information, that's a major bug.
Contents |
Guidelines
Creation
Create a normal Category page and add [[Category:About]] at the bottom to ensure it is visible from the Category:About page as well as the Special:Categories page. Think carefully if you should be creating a new category.
Usage
These pages can be referred to 'inline' in other wiki pages to avoid repetition.
Eg the step by step adaptation guide doesn't need to explain how to install mic2 or run mic2 (or even what mic2 is)... it simply refers to the [[:Category:mic2]] page.
What to include
Each category MUST have it's own page and this should provide a minimal useful amount of information tightly scoped to a concept; essentially a summary.
Links to internal wiki pages will automatically be present.
External links should be provided to other information sources such as:
- installation guides
- reference documentation
- tutorials
- wikipedia pages
- upstream/home pages
- git repositories
- OBS project location (eg Mer:Tools etc)
- service instances
- etc etc
The categories
Titles
- should use lowercase even for acronyms: so :Category:osc and :Category:boss.
- They should be one or two words : ":Category:community obs"
- Don't use "the": as in ":Category:the community OBS".
Category usage
Don't hyperlink every occurence of a concept found in the categories. Usually just the first one per document will suffice; more is OK if it's a large document read in sections or for different concepts such as installation and usage.
