Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
| wiki:wikirules [2018/03/03 20:56] – ↷ Links adapted because of a move operation bobafetthotmail | wiki:wikirules [2018/06/01 08:32] – LEDE -> OpenWrt 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. | ||
| Line 8: | Line 6: | ||
| ===== 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 **// | ||
| Line 17: | Line 15: | ||
| - **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 " | ||
| Line 26: | Line 24: | ||
| * // | * // | ||
| * // | * // | ||
| - | * // | + | * //[[:downloads: |
| * // | * // | ||
| * // | * // | ||