Difference between revisions of "Help:Funtoo Editing Guidelines"

From Funtoo
Jump to navigation Jump to search
Line 26: Line 26:
{{TableEnd}}
{{TableEnd}}


The basic concept is this -- some complications should simply ''be fixed in Funtoo'' rather than documenting ugly workarounds for problems. So be aware
The basic concept is this -- some complications should simply ''be fixed in Funtoo'' rather than documented in Funtoo 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]]. 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 dive in!
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 things 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 dive in!


[[Category:Wiki Development]]
[[Category:Wiki Development]]
[[Category:Official Documentation]]
[[Category:Official Documentation]]

Revision as of 05:00, February 24, 2019

Description:
This page documents the editing guidelines for the Funtoo Wiki.


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. See the table below:

Type of ChangeOkay?
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 IRC 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 in Funtoo 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 things 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 dive in!