Difference between revisions of "RPi Wiki Best Practice"

From eLinux.org
Jump to: navigation, search
(Get involved)
(Get involved)
Line 5: Line 5:
 
Need help ? Look here: [[Help:Contents]].
 
Need help ? Look here: [[Help:Contents]].
 
''' DICUSS ''' - Use the discussion pages ! <br>
 
''' DICUSS ''' - Use the discussion pages ! <br>
PROTIP: If you leave a message on the page,  use this signature <nowiki> ~~~~ </nowiki>. After saving , it will look like this : Ghans 16:47, 18 March 2012 (UTC)
+
PROTIP: If you leave a message on the page,  use this signature <nowiki> ~~~~ </nowiki>. <br>
 +
After saving , it will look like this : [[User:Ghans]] 16:47, 18 March 2012 (UTC)
  
 
=Keep basic structure=
 
=Keep basic structure=

Revision as of 06:41, 4 April 2012


Get involved

Need help ? Look here: Help:Contents. DICUSS - Use the discussion pages !
PROTIP: If you leave a message on the page, use this signature ~~~~ .
After saving , it will look like this : User:Ghans 16:47, 18 March 2012 (UTC)

Keep basic structure

  • add [[Category:RaspberryPi]] to each of your articles and uploads
  • put this at the end of your page :
=References= 

Looks better ;-)

Make it safe

make it clear to which audience the current page is aimed at , as seen here RPi Advanced Setup

Keep the beginners in mind.

Think of others

Goes hand in hand with Tip # 2. DO NOT BREAK LINKS. See Help:Moving_a_page and Help:Deleting_a_page. When the wiki gets more and more imortant over the time , we should avoid breaking old (and older) links. If you are unsure wheter your goal cannot achieved otherwise (logical link loop) , discuss with others first.

Use templates

Use the templates

  • {{Template:Raspberry Pi}} for the main pages
  • {{Template:RPi_Startup}} very important pages

Do not arbitarily extend and change them. They are specificially made for a better (BASIC) overview. Use Categories instead (Tip #1).

Keep it modular

If you see big lists and code listing cropping up , create a new article for them .

Bad Example : RPi Buying Guide had all the information now moved to RPi Buying Links By Country within a single page.

Please use the preview and see what monster you have created.

References