Difference between revisions of "Help:Funtoo Editing Guidelines"
Jump to navigation
Jump to search
m (remove IRC reference) |
|||
| (16 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Subpages|Basics,Images,Headings,Inline Code,Tables,Page Tools,Tips and Warnings,Source Code,Text Files,ConsoleOutput,Packages,Kernel,Translations,User Pages}} | {{Subpages|Basics,Images,Headings,Inline Code,Tables,Page Tools,Tips and Warnings,Source Code,Text Files,ConsoleOutput,Packages,Kernel,Translations,User Pages}} | ||
'''Thanks for your interest in contributing to | |||
'''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 | 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. | 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 | <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> | <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 | <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}} | ||
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! | |||
[[Category:Wiki Development]] | [[Category:Wiki Development]] | ||
[[Category:Official Documentation]] | [[Category:Official Documentation]] | ||
Latest revision as of 03:53, November 13, 2021
Subpages:
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!