Help:Funtoo Editing Guidelines
Thanks for your interest in contributing to the the Funtoo wiki!
Types of Edits
Before we get started, let's review what changes are okay to make, and what changes are not okay:
|Type of Change||Okay?|
|New wiki content||Yes|
|New package information||Yes|
|Adding to existing article||Maybe -- see below|
|Adding missing/incomplete information||Yes|
|Adding work-arounds to problems experienced||No - open bug first on bug tracker.|
Note that if you experience some problem with Funtoo Linux, during installation or otherwise, the proper course of action is to not add a work-around to our documentation, but to open a bug on our bug tracker. This is important because the problem you experienced may be a legitimate bug and the solution may be to fix the bug rather than add a work-around to our documentation. We may end up fixing a bug, making a documentation fix, or possibly both.
Here is a list of basic wiki information that you will need to know to get started:
- First, to perform edits on the wiki, you must Create a Funtoo account and log in.
- You can create a new page by navigating to http://www.funtoo.org/New_Page_Name. Underscores are the equivalent of spaces. Then select "Create" under the "Actions" menu.
- Whether creating a new page or editing an existing page by clicking "Edit", you will be presented with Web-based text editor that allows you to modify the wikitext of the page. The wikitext is rendered to produce the document you see when you view the page normally.
- Another fun thing you can do is click on your name under the "Account" menu once you have logged in. This will bring you to your "User" page. Then click "Create with Form" unde the "Actions" menu and enter your geographic and other information. This will allow you to be displayed on our Usermap and will also allow your full name to be displayed on Ebuild pages for which you are an author. It's generally a good idea to do this.
The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.
Marking Pages as Needing Updates
If you find outdated wiki content, but you don't have the time or ability to update it, add one of the following templates to the wikitext of the page. This will add the page to the Needs Updates Category so we can identify pages that need updating:
Examples of usage:
All-in-One (One Page) Install Guide
Once the section-by-section Install Guide is translated, it is possible to create a copy of The contents of the all-in-one-page Installation Guide -- click here to view it and click "Edit". Create your copy at "Install/languagecode" and paste the contents. Update minor things like the title but the calls to
translated_subpage can remain the same.
Next, good pages to translate are the ZFS, BTRFS and other pages in the Category:Official Documentation category. If you need more pages to translate, you can send me an email (either direct, or even better, go to User:Drobbins and then in the left-hand "Tools" section you will see an option to "Email this User" which you can use to send me a notification inside MediaWiki. I will then mark new pages for translation.
To upload images, head to Special:Upload and upload a file. Make sure that all images you upload have the same dimensions. When you upload, make note of the Destination Filename field -- this is the name that the upload will use when you reference it in your slide. It is recommended that you choose a simple descriptive name ending in ".jpg" or ".png" for the Destination Filename.