Difference between revisions of "Help:Funtoo Editing Guidelines"

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

Subpages:

Basics

Images

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 Edit	OK?
Grammar/spelling fixes	Yes
New wiki content	Yes
New package information	Yes
Adding to existing article	Yes
Adding missing/incomplete information	Yes
Making corrections	Yes
Adding workarounds to problems experienced, esp. install issues	Maybe 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!

@@ 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,Inline Code,Tables,Tips and Warnings,Source Code,Text Files,Console Output,Packages,Kernel}}
-'''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}}
-<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>New wiki content</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>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}}
-{{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.}}
-== 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]]
-===== 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:Official Documentation]]

Difference between revisions of "Help:Funtoo Editing Guidelines"

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

Navigation menu

Search