|There will be a Nuwiki IRC meeting|
|on Thursday, July 02, at 20.00h (8pm)
Central European Time (CEST)
in #openwrt-devel on Freenode.
|Please check out ircmeeting for topics to be discussed.
Please feel free to edit there as well.
(Yes yes, we know this is redundant…)
Please add here:
- Wiki structure
- Redundancy prevention tactics
- Categories and Tags
- Who can write up a usage guide on these?
- Should we make a template for /Sets of categories/ for both TOH & Documentation so that people know how to unify?
- Templates: Who creates what? ASSIGN ACTUAL PEOPLE HERE
- TOH (See TOH)
- "Maximum of 3 sublevels below namespace-rule"
- TOH (Table of Hardware)
- Linking between TOH and Documentation portion of the Wiki
- Wiki documentation mailinglist, is it needed or should -devel be used?
- Risks of stifling useful input by maintaining too tight a control
- Simplification of meta-pages: Remove all unnecessary text?
- We should go by month, starting from July
- What else?
- Who will call the next meeting, date , agenda etc.?
General comment: Please do not link into oldwiki (some ppl already did)
- On the redundancy thing; It's less likely to happen if we keep the structure flat (no openrtwdocs/openwrtdocs/docs/openwrt/howtobridge).
- TOH should be 'split by vendor' as basic catagories - with an integration of platform search option, make platform / feature listings realized by tags.
- Differentiate between platform instructions and device instructions and link to the exceptions in the corresponding device articles.
- Some devices might only require a small adjustment in the install procedure compared to the platform install instructions, and this needs to be both human readable for regular users and maintainable for us. Fx in redboot where you have different offsets and/or partition names, but the rest is always the same.
- device hardware info + picture of external and internal (link to dmesg/boot on separate sub-page)
- install steps
- exceptions to the expected
- serial, jtag info etc
The wiki needs a category of 'install instructions'. The install steps part of the device page contains either only "please see the <platform> installation instructions" with a link, or "please follow the instructions from $link, but after running $foo, please do $bar"
Various categories needed for 'howto pages' →
- 'packages', 'configuration'
- 'hardware mods'
- 'Development information' (details on tftp, failsafe, serial, jtag and other recovery methods) etc.
Device specific debrick instructions it can be on the device page. Platform specific stuff on the platform installation page that will cover the software side of jtag and any special notes if the jtag procedure deviates from what is to be expected for the platform. Instructions for building the actual cable should be on the hardware mod catebory.
Should be in the template: a box (button, text, whatever) pointing out:
- Which version this was written for.
- If this works for a later version please add that.
- If this doesnt work anymore, please put it back into inbox/inform mods/$action
All pages should be assumed to work for the latest stable release. If there is alternative information for other versions, it should be put below the stuff for the current version with explicit mentions of which version the instruction refers to. If somebody notices that a wiki page no longer applies to the current version and doesn't have time to fully fix it, he should add a short note to the header that mentions the version it was written for.
White Russian info should be left in the OldWiki.
At some point it would be good to have a list of devices recommended by the developers, basically a list of pointers to devices for which we believe openwrt support is solid
About the TOH in nuwiki, all the very specific information on flash and ram chip model numbers should be entered in the device page. The TOH should only list amount of RAM, Flash etc. People commonly placed those bits of data in the TOH, and they needlessly cluttered the old TOH.
Initial draft of new TOH will be started by Bartman007 and glp.
We'll have to take a wait and see approach.
- Get moderators and admins set up
- Define namespaces/categories even if they are just stubs
- Explain what images/targets are for which devices.
- Beat every developer into adding their hardware to the TOH (don't need to create device pages, just add to TOH)
- Get started with the installation docs for most targets.
In roughly two weeks, Peter Lambrechtsen will make the call.
meta/ircmeeting/2009-07-02.txt · Last modified: 2009/07/22 13:00 (external edit)