Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revisionBoth sides next revision
wiki:wikirules [2018/03/04 12:41] bobafetthotmailwiki: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 "professional" look, but it will also be harder to read and edit for casual users and contributors. More advanced layouts with tabs and buttons are more compact but are usually more confusing than a simpler layout with just a single list of actions and links where readers scroll through and click. Also a simple non-interactive layout allows easy printing. For example, look at this tutorial [[docs:guide-quick-start:factory_installation|Factory install: First-time installation of LEDE on a device]].\\ \\+  - **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 "professional" look, but it will also be harder to read and edit for casual users and contributors. More advanced layouts with tabs and buttons are more compact but are usually more confusing than a simpler layout with just a single list of actions and links where readers scroll through and click. Also a simple non-interactive layout allows easy printing. For example, look at this tutorial [[docs:guide-quick-start:factory_installation|Factory install: First-time installation on a device]].\\ \\
   - **Avoid duplicating information within this wiki** : Information on the same topic shall appear in the wiki only **//once//**. If it is needed somewhere else, we refer to it with a link!\\ For example if you are writing a tutorial and one of the step is "configure USB storage" you should link to [[docs:guide-user:storage:usb-drives|Using storage devices]]. DO NOT write down (or copy-paste) the same procedures in your new tutorial! \\ \\   - **Avoid duplicating information within this wiki** : Information on the same topic shall appear in the wiki only **//once//**. If it is needed somewhere else, we refer to it with a link!\\ For example if you are writing a tutorial and one of the step is "configure USB storage" you should link to [[docs:guide-user:storage:usb-drives|Using storage devices]]. DO NOT write down (or copy-paste) the same procedures in your new tutorial! \\ \\
   - **Avoid duplicating upstream documentation** : consider contributing the more generic parts of the documentation to **//upstream//**, and just link to that in your article. This wiki exists for OpenWrt-related documentation, for example [[docs:guide-user:network:ipv4:start]]. Some example upstream wikis: i.e. [[https://wireless.wiki.kernel.org/|Linux WiFi drivers wiki]], [[https://community.openvpn.net/openvpn/wiki|OpenVPN Wiki]] etc. Not all employ wikis, and not all accept contributions from third parties. If upstream contributions are impossible, then it's fine to have that info in the OpenWrt wiki. \\ \\   - **Avoid duplicating upstream documentation** : consider contributing the more generic parts of the documentation to **//upstream//**, and just link to that in your article. This wiki exists for OpenWrt-related documentation, for example [[docs:guide-user:network:ipv4:start]]. Some example upstream wikis: i.e. [[https://wireless.wiki.kernel.org/|Linux WiFi drivers wiki]], [[https://community.openvpn.net/openvpn/wiki|OpenVPN Wiki]] etc. Not all employ wikis, and not all accept contributions from third parties. If upstream contributions are impossible, then it's fine to have that info in the OpenWrt wiki. \\ \\
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 "**installing and configuring Adblock**". General articles that span many different topics, for example "**filtering web traffic**" (where you talk of Adblock, proxy servers, and maybe Tor and VPNs) should be split up. \\ \\   - **One topic per article**. Articles should be focused on a single, focused topic, for example "**installing and configuring Adblock**". General articles that span many different topics, for example "**filtering web traffic**" (where you talk of Adblock, proxy servers, and maybe Tor and VPNs) should be split up. \\ \\
-  - **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**").  For example [[docs:guide-quick-start:factory_installation|Factory install: First-time installation of LEDE on a device]] or this [[docs:guide-developer:helloworld:start|"Hello, world!" for LEDE]] \\ \\+  - **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**").  For example [[docs:guide-quick-start:factory_installation|Factory install: First-time installation on a device]] or this [[docs:guide-developer:helloworld:start|"Hello, world!" for OpenWrt]] \\ \\
   - **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 "**chain**" icon you find on the right tool panel (it's under the **clock** icon). \\ \\   - **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 "**chain**" icon you find on the right tool panel (it's under the **clock** icon). \\ \\
  
  • Last modified: 2023/05/31 10:12
  • by paulfertser