From Fedora Project Wiki

(adding a small disclaimer)
(making link text more clear)
Line 6: Line 6:
 
This page not intended to be a [[DocsProject/StyleGuide|style guide]], but rather a guide indicating what technical elements are required for a wiki page to be considered complete from a wiki gardening perspective.
 
This page not intended to be a [[DocsProject/StyleGuide|style guide]], but rather a guide indicating what technical elements are required for a wiki page to be considered complete from a wiki gardening perspective.
  
This page is not for teaching [http://meta.wikimedia.org/wiki/Help:Editing|how to do wiki formatting], nor the [[Help:Editing|special guidelines for the Fedora wiki]].
+
This page is not for teaching [http://meta.wikimedia.org/wiki/Help:Editing|how to do wiki formatting], nor the special [[Help:Editing|wiki formatting guidelines for the Fedora wiki]].
  
 
==Page naming==
 
==Page naming==

Revision as of 20:27, 20 August 2008

DocsProject Header docTeam1.png


Error creating thumbnail: File missing
This page is a draft only
It is still under construction and content may change. Do not rely on the information on this page.
Error creating thumbnail: File missing
This is a page that describes policies of the Fedora Project.
For policy pages, accuracy and clarity are important. You are encouraged to edit the wiki to improve it. If you have any substantive changes to make to this page, use the talk page to discuss the changes with other page maintainers. Do this before making the changes.

Introduction

This page not intended to be a style guide, but rather a guide indicating what technical elements are required for a wiki page to be considered complete from a wiki gardening perspective.

This page is not for teaching to do wiki formatting, nor the special wiki formatting guidelines for the Fedora wiki.

Page naming

The current naming convention is to largely abandon

Links

Links to the Fedora Project wiki should always be internal links, and not external links.

Size

Generally you should consider splitting a document into multiple pages if the document size exceeds 32KB. This is by no means a hard limit but rather one element to take into consideration.

Header

If a header exists for a given project that a page belongs to it should be included in the documents.

Headings

You should subdivide your content with headings. Mediawiki automatically will create table of contents. Using headers also permits you to link directly to sections of a page.

Includes

Do not repeat content from another page manually. That creates additional work to edit and change. Using includes permits changes to occur in one place and be updated everywhere it is used.

Categories

Each page should have at least one category, and it will be a rare page that has only one catgory. In our current implementation Categories are the guide spaces for the wiki. You can find a list of all categories here.