Difference between revisions of "Help:Funtoo Editing Guidelines"

From Funtoo
Jump to navigation Jump to search
m (remove IRC reference)
 
(36 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
{{Subpages|Basics,Images,Headings,Inline Code,Tables,Page Tools,Tips and Warnings,Source Code,Text Files,ConsoleOutput,Packages,Kernel,Translations,User Pages}}
{{NavHeader
|name=Editing Guidelines
|authors=[[User:Drobbins|Daniel Robbins]]
|description=This page documents the editing guidelines for the Funtoo Wiki.}}
{{Subpages|Basics,Headings,Tables,Source Code,Text Files,Console Output,Packages}}


'''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:
 
'''Thanks for your interest in contributing to the Funtoo Wiki!'''
 
Before we get started, it's a good idea to review what kinds of changes to the wiki
we're looking for, and what kind of changes we're not looking for.
 
Most of the time it's good to document stuff. But because we want Funtoo Linux to be as seamless an experience as possible, sometimes the best approach is to use IRC or forums for support, or file a bug on our bug tracker. See the table below for the types of wiki edits we consider to be OK:


{{TableStart}}
{{TableStart}}
<tr class="active"><th>Type of Change</th><th>Okay?</th></tr>
<tr class="active"><th>Type of Edit</th><th>OK?</th></tr>
<tr><td>Grammar/spelling fixes</td><td>Yes</td></tr>
<tr><td>Grammar/spelling fixes</td><td>Yes</td></tr>
<tr><td>New wiki content</td><td>Yes</td></tr>
<tr><td>New wiki content</td><td>Yes</td></tr>
<tr><td>New package information</td><td>Yes</td></tr>
<tr><td>New package information</td><td>Yes</td></tr>
<tr><td>Adding to existing article</td><td>Maybe -- see below</td></tr>
<tr><td>Adding to existing article</td><td>Yes</td></tr>
<tr><td>Adding missing/incomplete information</td><td>Yes</td></tr>
<tr><td>Adding missing/incomplete information</td><td>Yes</td></tr>
<tr><td>Making corrections</td><td>Yes</td></tr>
<tr><td>Making corrections</td><td>Yes</td></tr>
<tr class="danger"><td>Adding work-arounds to problems experienced</td><td>No - open bug first on [http://bugs.funtoo.org bug tracker].</td></tr>
<tr class="danger"><td>Adding workarounds to problems experienced, esp. install issues</td><td>Maybe not - try forums or Discord/Telegram first, and possibly open bug first on [https://bugs.funtoo.org bug tracker].</td></tr>
{{TableEnd}}
{{TableEnd}}


{{important|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.}}
The basic concept is this -- some complications should simply ''be fixed in Funtoo'' rather than documented for users as ugly workarounds. So be aware
 
of types of issues that may fall into this category and take appropriate action such as [https://bugs.funtoo.org filing a bug]. We want the Funtoo experience to be as straightforward as possible, especially for new users. Now that that's out of the way, please browse the '''subpage links at the top of the page''' to familiarize yourself with Funtoo editing guidelines -- and have fun!
=== Basics ===
 
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 {{CreateAccount}} 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 [[:Category:Ebuilds|Ebuild pages]] for which you are an author. It's generally a good idea to do this.
 
{{tip|The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.}}
 
=== Informational Messages ===
Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:
 
<pre>{{note|this is a note}}</pre>
{{note|this is a note}}
 
<pre>{{important|this is important}}</pre>
{{important|this is important}}
 
<pre>{{warning|this is a warning}}</pre>
{{warning|this is a warning}}
 
<pre>{{tip|this is a tip}}</pre>
{{tip|this is a tip}}
 
Note that these templates used to be called <code>fancynote</code>, <code>fancytip</code>, etc. The "fancy" names have been deprecated but will still be supported for the forseeable future.
 
=== Kernelop ===
To display kernel configuration options, we encourage you to use the <tt>kernelop</tt> template. To use the <tt>kernelop</tt> template, create an entry similar to the following example:
<pre>
{{kernelop|title=foo,bar|desc=
kernel options pasted from "make menuconfig"
}}
</pre>
 
{{note|Kernelop is colored blue to slightly resemble the blueish background from <tt>make menuconfig</tt>.}}
 
Adding this entry will give you the following output:
{{kernelop|title=foo,bar|desc=
kernel options
}}
 
Here's a more concrete example:
{{kernelop|title=File systems|desc=
<M> Second extended fs support         
[ ]  Ext2 extended attributes         
[ ]  Ext2 execute in place support   
<M> Ext3 journalling file system support
}}
 
Examples of usage:
* [[Package:AMD Catalyst Video Drivers]]
* [[Package:ACPI Daemon]]
* [[Microcode]]
 
== 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 [[:Category:Needs Updates|Needs Updates Category]] so we can identify pages that need updating:
 
<pre>
{{PageNeedsUpdates}}
{{SectionNeedsUpdates}}
</pre>
 
 
Examples of usage:
* [[UEFI Install Guide]]
* [[Package:MediaWiki]]
* [[Clang]]
 
=== Inline Code ===
 
To emphasize commands, and other technical jargon when they appear inline in a paragraph, use the <nowiki>{{c}}</nowiki> template. When referencing files, use the <nowiki>{{f}}</nowiki> template.
 
<pre>
The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.
</pre>
 
This example produces the following output:
 
The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.
 
{{important|1=
The &#60;tt&#62; tag has been deprecated for the purpose of tagging inline code, to conform with HTML5, and the previous use of the &#60;code&#62; tag is discouraged. It is more maintainable to use the <nowiki>{{c}}</nowiki> template. }}
 
=== Translations ===
 
We are starting to use the official MediaWiki Translate extension for translating page contents. I recommend focusing primarily on the {{Install|Install Guide}} for translation, and only moving on to other things once the Install Guide translation is 100% complete.
 
==== Section-by-Section Install Guide Translation ====
 
To translate the Install Guide, start with the {{Install|section-by-section format}} and choose "Translate this page", and work through it a section at a time.
 
Also note that you can go to [https://www.funtoo.org/Special:Translate?group=funtoo-install&language=bho&action=translate] to translate special user interface text we use like "Chapter", "Install Guide", "Tip", "Important", etc.
 
===== Navigation Buttons =====
 
The section-by-section Install Guide has a blue navigation section which is used to navigate to the previous or next section. Here's how it works for translated pages. If you are on a translated section, and you want to go to the "next" section, and a translated section for the next section exists, then the link will point to the next translated page. But, if the translated version of the next page doesn't exist, then you will get linked to the English version of the section. Once you are in an English version of the section, you have been "de-railed" into the English document and the navigation will not "jump back" into your translated sections. But this allows users who are using your incomplete translated documentation to at least start reading the translated version, and click through to the end of the documentation without having any missing pages.
 
Once all sections exist in the translated language, then the "next" and "prev" links will stay in your translated sections, and the user will only go back to English if they select the English translation from the languages area.
 
==== 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 -- [[Install|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 {{c|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.
 
==== Upload Images ====
 
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'''.
 
 
[[Category:Wiki Development]]
[[Category:Wiki Development]]
[[Category:Official Documentation]]
[[Category:Official Documentation]]

Latest revision as of 03:53, November 13, 2021


Thanks for your interest in contributing to the Funtoo Wiki!

Before we get started, it's a good idea to review what kinds of changes to the wiki we're looking for, and what kind of changes we're not looking for.

Most of the time it's good to document stuff. But because we want Funtoo Linux to be as seamless an experience as possible, sometimes the best approach is to use IRC or forums for support, or file a bug on our bug tracker. See the table below for the types of wiki edits we consider to be OK:

Type of EditOK?
Grammar/spelling fixesYes
New wiki contentYes
New package informationYes
Adding to existing articleYes
Adding missing/incomplete informationYes
Making correctionsYes
Adding workarounds to problems experienced, esp. install issuesMaybe not - try forums or Discord/Telegram first, and possibly open bug first on bug tracker.

The basic concept is this -- some complications should simply be fixed in Funtoo rather than documented for users as ugly workarounds. So be aware of types of issues that may fall into this category and take appropriate action such as filing a bug. We want the Funtoo experience to be as straightforward as possible, especially for new users. Now that that's out of the way, please browse the subpage links at the top of the page to familiarize yourself with Funtoo editing guidelines -- and have fun!