Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision | ||
| playground:wikirules [2018/01/29 14:29] – bobafetthotmail | wiki:wikirules [2022/04/22 07:04] – [Structure] inbox + playground added tmomas | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Wiki contribution guide ====== | ====== Wiki contribution guide ====== | ||
| - | |||
| - | |||
| The following standards should help keeping the wiki consistent, easy to understand for newbies, and easy to edit for casual contributors. | The following standards should help keeping the wiki consistent, easy to understand for newbies, and easy to edit for casual contributors. | ||
| There can be exceptions in some cases where it makes sense, but there should be a good reason for that. | There can be exceptions in some cases where it makes sense, but there should be a good reason for that. | ||
| + | |||
| + | \\ | ||
| + | |||
| + | {{section> | ||
| ===== Mantras ===== | ===== Mantras ===== | ||
| - | - **Articles must be easy to read and easy to edit, simpler is better.** Articles should be formatted only using basic features found in the editor GUI, plus the code tag and table construct where necessary.\\ Why? More advanced formatting would give this wiki a more " | + | - **Articles must be easy to read and easy to edit, simpler is better.** Articles should be formatted only using basic features found in the editor GUI, plus the code tag and table construct where necessary.\\ Why? More advanced formatting would give this wiki a more " |
| - | - **Avoid duplicating information within this wiki** : Information on the same topic shall appear in the wiki only **// | + | - **Avoid duplicating information within this wiki** : Information on the same topic shall appear in the wiki only **// |
| - | - **Avoid duplicating upstream documentation** : consider contributing the more generic parts of the documentation to **// | + | - **Avoid duplicating upstream documentation** : consider contributing the more generic parts of the documentation to **// |
| - | - **Versioning information**: | + | - **Versioning information**: |
| - | - **Articles should be easy to find** most people will search for information with the search engine of their choice, or with the wiki's own internal search. Use short, descriptive titles and introductions that contain the right keywords to be found. You can try to search for your article with your favorite search engine (after a few days you posted the article, because search engines need time to update their indexes). If you won't find your own content, others probably won't as well!\\ E.g. **installing.opkg.packages.in.mount.point.other.than.root** is a long title that could be replaced with something like //opkg -- Installation Destinations//, | + | - **Articles should be easy to find** most people will search for information with the search engine of their choice, or with the wiki's own internal search. Use short, descriptive titles and introductions that contain the right keywords to be found. You can try to search for your article with your favorite search engine (after a few days you posted the article, because search engines need time to update their indexes). If you won't find your own content, others probably won't as well!\\ E.g. **installing.opkg.packages.in.mount.point.other.than.root** is a long title that could be replaced with something like //opkg -- Installation Destinations//, |
| - | - **Articles should explain why they exist, what is their goal**. Please add an " | + | - **Articles should explain why they exist, what is their goal**. Please add an " |
| - | - **Articles should contain VERIFIABLE information, | + | - **Articles should contain VERIFIABLE information, |
| - | - **All tutorials you write must be tested personally or must have a warning** stating that testing was not possible when writing them (and to remove the warning when someone successfully tested it). | + | - **All tutorials you write must be tested personally or must have a warning** stating that testing was not possible when writing them (and to remove the warning when someone successfully tested it). \\ \\ |
| - | - **One topic per article**. Articles should be focused on a single, focused topic, for example " | + | - **One topic per article**. Articles should be focused on a single, focused topic, for example " |
| - | - **Large tutorials should be split up**. Large tutorials where each step is long should be split up in separate articles, each covering a part of the steps. This is even more important if the tutorial contains conditional or optional steps (for example: "do step **A**, then you can do either step **B** or **C**, then do **D**" | + | - **Large tutorials should be split up**. Large tutorials where each step is long should be split up in separate articles, each covering a part of the steps. This is even more important if the tutorial contains conditional or optional steps (for example: "do step **A**, then you can do either step **B** or **C**, then do **D**" |
| - | - **Articles should be accessible from within the wiki** Please make sure your article has a link in one of the main Categories pages (links below) if it is some kind of tutorial. Some articles may not need this if they are part of a multi-article tutorial, but again make sure ALL articles can be reached either from the main Categories pages or from the other pages of its multi-article tutorial. Very popular articles will also be linked from within other tutorials, as explained in the **Avoid duplicating information within this wiki** mantra above. For a handy list of pages linking to the current page, click on the " | + | - **Articles should be accessible from within the wiki** Please make sure your article has a link in one of the main Categories pages (links below) if it is some kind of tutorial. Some articles may not need this if they are part of a multi-article tutorial, but again make sure ALL articles can be reached either from the main Categories pages or from the other pages of its multi-article tutorial. Very popular articles will also be linked from within other tutorials, as explained in the **Avoid duplicating information within this wiki** mantra above. For a handy list of pages linking to the current page, click on the " |
| ===== Structure ====== | ===== Structure ====== | ||
| Line 30: | Line 32: | ||
| * // | * // | ||
| * // | * // | ||
| + | * // | ||
| + | * // | ||
| * **Categories** provide the first level of the namespaces. They distinguish different kinds of **docs**: | * **Categories** provide the first level of the namespaces. They distinguish different kinds of **docs**: | ||
| - | * // | + | * // |
| - | * //[[docs:user-guide:|User Guide]]// most of the documentation for users goes here | + | * // |
| * // | * // | ||
| Line 39: | Line 43: | ||
| * [[meta: | * [[meta: | ||
| - | **Sidebar** | + | To ease navigation, we use a [[sidebar:|sidebar]]. |
| - | To ease navigation, we use a sidebar, in two places to " | + | |
| - | * //[[docs:sidebar|Sidebar for Docs section]]// | + | |
| - | * //[[sidebar:|Sidebar for general section]]// | + | |