Difference between revisions of "Maintaining the Wiki"

(Created page with "{{Popup-warning|content=This page is not yet complete, and the sync system is not yet set up!}} A while ago we switched from supertuxkart.sourceforge.net to simply supertuxka...")
 
(More work on wiki maintenance page)
Line 6: Line 6:
  
 
Our new approach is to only allow a few select people have wiki accounts. We now have a service that automatically syncs the wiki content with GitHub, and you can fork the repository, submit pull requests, and file issue reports—all without allowing wiki account creation. This page covers how YOU can start contributing to keep the wiki organized, friendly, and up-to-date.
 
Our new approach is to only allow a few select people have wiki accounts. We now have a service that automatically syncs the wiki content with GitHub, and you can fork the repository, submit pull requests, and file issue reports—all without allowing wiki account creation. This page covers how YOU can start contributing to keep the wiki organized, friendly, and up-to-date.
 +
 +
== MediaWiki Markup ==
 +
 +
This website is powered by MediaWiki. Pages are written in MediaWiki's own markup language. Some basic formatting can be found [https://www.mediawiki.org/wiki/Help:Formatting here].
 +
 +
To maintain a the same style throughout the wiki, as well as preserve mobile-friendliness, we do require a few restrictions on what markup you may use.
 +
 +
* Use only level-2 headings and below (e.g. <code><nowiki>== Level 2 ==</nowiki></code>). Level-1 headings are for page titles only.
 +
* Use logical heading order.
 +
* When using tables in documentation, be sure that you are using the wikitable class: {{Popup-code|content=<nowiki>
 +
{| class="wikitable"
 +
!Heading cell 1
 +
!Heading cell 2
 +
|-
 +
|Data cell 1
 +
|Data cell 2
 +
|}</nowiki>}}
 +
* Use packed galleries for images to preserve mobile-friendliness: {{Popup-code|content=<nowiki>
 +
<gallery mode="packed" widths="640px" heights="480px">
 +
File:Example.png
 +
</gallery></nowiki>}}
 +
* To maintain readability of code,
 +
** Put an empty line above and below headings.
 +
** Put a space between heading markup (<code>==</code>)and headings.
 +
 +
== Maintaining Documentation ==
 +
 +
While most programming documentation uses Doxygen and therefore is not maintained on the wiki, all the artists' documentation is on this website, linked from the [[Art Portal]].
 +
 +
=== Format of Artists' Tutorials ===
 +
 +
It's important to have a standard format for tutorials. Every tutorial has an index page titled "Making <Art type>" (e.g. [[Making Tracks]]). This page uses the '''Popup-prerequisite''' template, followed by a short introduction, a level 2 heading "Contents," and a series of bullet points with links to various chapters of the tutorial.

Revision as of 23:56, 12 September 2016

A while ago we switched from supertuxkart.sourceforge.net to simply supertuxkart.net. But we also made a lot more changes: a new version of MediaWiki, a new skin, and, perhaps most importantly, no more open user registration.

Why? Well, there were a number of reasons. There was no quality assurance on the old wiki. The problem with running a website using wiki software is that it's still a wiki: anyone can edit it. If we had maintained a separate wiki, this might not have been quite such a problem, but as a result, the entire website looked unprofessional, confusing, and outdated.

Our new approach is to only allow a few select people have wiki accounts. We now have a service that automatically syncs the wiki content with GitHub, and you can fork the repository, submit pull requests, and file issue reports—all without allowing wiki account creation. This page covers how YOU can start contributing to keep the wiki organized, friendly, and up-to-date.

MediaWiki Markup

This website is powered by MediaWiki. Pages are written in MediaWiki's own markup language. Some basic formatting can be found here.

To maintain a the same style throughout the wiki, as well as preserve mobile-friendliness, we do require a few restrictions on what markup you may use.

  • Use only level-2 headings and below (e.g. == Level 2 ==). Level-1 headings are for page titles only.
  • Use logical heading order.
  • When using tables in documentation, be sure that you are using the wikitable class:
  • Use packed galleries for images to preserve mobile-friendliness:
  • To maintain readability of code,
    • Put an empty line above and below headings.
    • Put a space between heading markup (==)and headings.

Maintaining Documentation

While most programming documentation uses Doxygen and therefore is not maintained on the wiki, all the artists' documentation is on this website, linked from the Art Portal.

Format of Artists' Tutorials

It's important to have a standard format for tutorials. Every tutorial has an index page titled "Making <Art type>" (e.g. Making Tracks). This page uses the Popup-prerequisite template, followed by a short introduction, a level 2 heading "Contents," and a series of bullet points with links to various chapters of the tutorial.