User Tools

Site Tools



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

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
meta:start [2012/11/29 17:27]
meta:start [2016/10/03 08:30] (current)
tmomas alte Version wieder hergestellt (2016/01/05 23:04)
Line 1: Line 1:
 +====== Welcome to the Gardeners Lounge ======
 +===== Quick Guide for Wiki Contributors ======
 +  * You find templates here: **[[meta:​templates]]**
 +  * The syntax for DokuWiki can be found here: **[[meta:​syntax]]**
 +  * For wiki related ideas, questions and critique, see **[[meta:​discussion]]**
 +  * How we **[[communication|communicate]]** with each other
 +  * If you want to work on migration, see [[meta:​migrating]]
 +  * If you want to read a fancy [[meta:​howtohowto|HowTo write a Howto]]
 +  * **[[Translation]]**
 +===== Mantras =====
 +  * **Redundancy** (or Modularity I) : Information shall appear in the wiki only **//​once//​**. If it be needed somewhere else, we refer to it with a link!\\ Articles you //shall// link to are e.g. [[doc:​howto:​]],​ [[doc:​howto:​LuCI]],​ [[doc:​howto:​generic.overview]],​ [[doc:​howto:​generic.flashing]],​ etc. DO NOT explain those procedures again!
 +  * **Cooperation** (or Modularity II): seriously consider contributing **//up stream//**. Put only OpenWrt-related stuff here, for example [[doc:​howto:​wireless.overview]],​ but contribute more general information up stream: i.e. [[http://​​]],​ [[wp>​Comparison_of_open_source_wireless_drivers]],​ etc. For more upstream pages look [[doc:​techref:​externaldocumentation|here]]. Not all employ wikies.
 +  * **Actuality**:​ all articles should generally reflect information that is valid for the **//current stable release//​**. Information that applies to trunk builds //only//, should be marked as such.
 +  * **Searchability** most people will search for information with the search engine of their choice. The less garbage there is in this wiki, the better articulated content and titles are, the higher the probability that information is found **//​swiftly//​**! Feel free to try and solve some problem by searching for a solution with your favorite search engine. If you won't find your own content, others probably won't as well!\\ E.g. [[doc/​howto/​​]] is a long title that could be replaced with something like //opkg --  Installation Destinations//,​ but the latter will not be as easily be found as the first one when someone does not browse the wiki, but uses a search engine instead.
 +===== Structure ======
 +To give the Wiki a better [[:​start?​do=index|structure]],​ we employ ''​namespaces''​ and ''​categories''​ (and ''​tags''​):​
 +  * **Namespaces** are highest. In each of these upper namespaces, there shall be a maximum of 3 (three) sublevels.
 +    * //​[[about:​|about]]//​ about the project in general, about OpenWrt Buildroot, etc.
 +    * //​[[toh:​|TOH]]//​ (aka Table of Hardware),
 +    * //​[[doc:​|Documentation]]//​
 +    * //​[[meta:​|Meta]]//​ is this page
 +    * //​[[inbox:​|Inbox]]//​
 +    * //​[[oldwiki:​|Oldwiki]]//​ serves as source and inspiration for new documentation. **Please do NOT link from wiki (=nuwiki) into the oldwiki namespace!** Please rather [[meta:​migrating|migrate]] stuff when you have the time.
 +  * **Categories** provide the first level of the namespaces. They distinguish different kinds of **docs**:
 +    * [[doc:​devel:​]] //!OpenWrt explicitly addresses developers!//​
 +    * [[doc:​faq:​]]
 +    * [[doc:​hardware:​]] ​ about the hardware: about SoC, about CPUs (often called Cores), about soldering, etc. //​Cooperation//​ with other Wikis //WANTED//
 +    * [[doc:​howto:​]] stuff you do, **after** you successfully installed OpenWrt.
 +    * [[doc:​howtobuild:​]] ​ stuff you do **before** you even have an image
 +    * [[doc:​recipes:​index|recipes]] probed scenarios
 +    * [[doc:​techref:​]] Technical Reference
 +    * [[doc:​uci:​]] ​ explanations for specific uci-configuration files like ''​[[doc:​uci:​network|/​etc/​config/​network]]''​
 +  * **Tags** are different. While the structure is exclusive, you can place an article only in one subcategory,​ tags are more flexible. More of them can be placed simultaneously in one article, and thus allow for a more flexible categorizing. To reproduce this with the structure we could write symbolic articles, which are placed in different subcategories and redirect to one article. But let's not do that. Tags will prove most useful, when you want to search for routers with certain features.
 +    * [[meta:​tags]] Overview
 +===== Guides =====
 +Instead of just blindly relying on the logic of our structure, I've taken the liberty to create some //guides//. These articles address certain users or a certain task to be done. They contain little own content but many links to already existent articles:
 +  * [[doc:​howto:​user.beginner]] is better then a naked [[doc:​howto:​generic.flashing]]
 +  * [[doc:​howto:​basic.config]] is kind of an über-article for [[doc:UCI]] and non-UCI configurations for all starters
 +  * [[doc:​howto:​internet.connection]] is kind of an über-article for [[doc:​uci:​network]]
 +  * [[doc:​howto:​user.advanced]] is somehow superfluous,​ its content could be merged into a couple of about-articles
 +Also some articles to further help users:
 +  * [[doc:​howto:​user.beginner.cli]]
 +  * [[doc:​howto:​user.beginner.lazy]]
 +Again: Beginners lack knowledge and experience, they are not (necessarily) stupid!
 +===== ToDo List =====
 +If you want to contribute, these are the top open issues we need help with:
 +  - Migrating Oldwiki pages [[meta:​migrating]]
 +  - A solution for redundancy and the hardware features: We describe it in the ToH, then under "​Hardware Highlights",​ then under "​Info"​ in the hardware section and then again in the tag-footer. That's four times exactly the same information! What we want is to have the info only once and then point to it.
 +  - [[meta:​templates|Templates]] for articles
 +  - Howto for moderators [[meta:​moderating]].
 +For finding stuff if visitors use their brains instead of the search function:
 +  * [[doc/​start#​howtos]] "​Overview"​-Articles like [[doc:​howto:​webinterface.overview]] or [[doc/​howto/​http.overview]]. This is particularly useful, because many packages names say nothing about their functionality. Sometimes a simple ''​opkg info *webserver*''​ does help, but very often it does not. You definitely won't find //all// web servers that way. Especially the English language does not have any stern rules on howto to write composite words. Could be web server, webserver, web-server, http-server,​ you name it. That's why we use the protocol names: HTTP, FTP, SMTP, etc ;-)
 +===== Users and Permissions =====
 +  * **Visitors** just pass by and read what they find useful. They don't need logins. ​
 +  * **Gardeners** are all the great people creating and editing information in this wiki. Gardeners are allowed to edit all docs and can create pages almost anywhere. ​ To create a page, type the url to the not yet existing page then hit the "​Create this page" link.  See [[:​inbox:​start|this page]] for more.  To be a gardener all you need to do is to create an account and log in. 
 +  * **Moderators** are the ones who are mastering the disaster, they need to keep looking at the inbox and have an eye on edits throughout the entire wiki. Moderators take care of, and have of their focus on, structure and content.
 +  * **Admins** are there to help out everywhere and also manage user permissions.
 +More information on the moderation process: [[meta:​moderating]].
 +===== Redirects =====
 +@ADMINS: It would be nice, if redirects would only be needed to keep things working from the outside, i.e. if you move a page, and somebody had bookmarked this, a redirect could make this bookmark still work.
 +It would however not be good, if the internal links would rely on working redirects! In Dokuwiki redirects are provided by a Plugin.