The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.
Difference between revisions of "Help:Funtoo Editing Guidelines"
(→Basics) |
|||
| Line 6: | Line 6: | ||
{{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 the the Funtoo wiki!''' | '''Thanks for your interest in contributing to the the Funtoo wiki!''' | ||
Before we get started, | 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. While we love wiki contributions, the wiki can be used in a way that is not ideal. Generally, anything that isn't a ''workaround for a problem you are experiencing'' is generally fair game for the wiki. Here are the types of changes | |||
that are OK and not OK: | |||
{{TableStart}} | {{TableStart}} | ||
| Line 19: | Line 20: | ||
<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 [ | <tr class="danger"><td>Adding work-arounds to problems experienced</td><td>No - open bug first on [https://bugs.funtoo.org bug tracker].</td></tr> | ||
{{TableEnd}} | {{TableEnd}} | ||
So, make a mental note -- 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'', or if your problem is potentially a support issue, ask for help on IRC or our forums. 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, or the problem may be an issue that requires support rather than an actual documentation fix. | |||
[[Category:Wiki Development]] | [[Category:Wiki Development]] | ||
[[Category:Official Documentation]] | [[Category:Official Documentation]] | ||
Revision as of 03:55, February 24, 2019
Thanks for your interest in contributing to the 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. While we love wiki contributions, the wiki can be used in a way that is not ideal. Generally, anything that isn't a workaround for a problem you are experiencing is generally fair game for the wiki. Here are the types of changes that are OK and not OK:
| Type of Change | Okay? |
|---|---|
| Grammar/spelling fixes | Yes |
| New wiki content | Yes |
| New package information | Yes |
| Adding to existing article | Maybe -- see below |
| Adding missing/incomplete information | Yes |
| Making corrections | Yes |
| Adding work-arounds to problems experienced | No - open bug first on bug tracker. |
So, make a mental note -- 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, or if your problem is potentially a support issue, ask for help on IRC or our forums. 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, or the problem may be an issue that requires support rather than an actual documentation fix.