注意：

The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.

Difference between revisions of "Help:Funtoo Editing Guidelines"

From Funtoo
Jump to navigation Jump to search
Line 11: Line 11:


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. 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
we're looking for, and what kind of changes we're not looking for.
that are OK and not OK:
 
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.


{{TableStart}}
{{TableStart}}
Line 24: Line 25:
<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>
<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 04:02, February 24, 2019

Description:
This page documents the editing guidelines for the Funtoo Wiki.
Authors:
Daniel Robbins
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!

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.

Type of ChangeOkay?
Grammar/spelling fixesYes
New wiki contentYes
New package informationYes
Adding to existing articleMaybe -- see below
Adding missing/incomplete informationYes
Making correctionsYes
Adding work-arounds to problems experiencedNo - open bug first on bug tracker.
Retrieved from "https://www.funtoo.org/index.php?title=Help:Funtoo_Editing_Guidelines&oldid=27166"