User Tools

Site Tools


meta:discussion

Differences

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:discussion [2012/10/01 22:47]
meta:discussion [2016/01/21 07:57] (current)
tmomas alte Version wieder hergestellt (2015/12/19 18:02)
Line 1: Line 1:
 +====== Discussions ======
 +----
 +/* Follow instructions for each subheading. */
  
 +This is the meta discussions page, where discussions on the [[:​start|OpenWrt Wiki]] take place.
 +
 +After you comment, at the end, sign your name using the "​Insert Signature [Y]" button in the wiki edit toolbar. You can optionally edit the signature to include contact information,​ for example, based on any of these formats: <​code>​ --- // [[optional@email.com|Name]] 2010/01/15 11:30 //
 + --- // [[https://​forum.openwrt.org/​profile.php?​id=0000|Alias]] 2010/01/15 11:30 //</​code>​
 +
 +Separate questions belong in its own subsection with its own descriptive subheading title. In this way, questions can be easily distinguished among others. For example: <​code>​==== Report wiki issues ====</​code>​
 +
 +===== Unresolved questions =====
 +----
 +When you add a question, please add it to the bottom of the list so that it is sorted in ascending order (newest last). Once a question has been resolved, to avoid clutter, please move it to the [[Discussion#​Resolved questions]] section, sorted in ascending order (newest last).
 +
 +
 +==== How to document procedures for different versions of OpenWRT ====
 +> Where a procedure is different between, say, Attitude Adjustment and Backfire, how should the difference be shown?
 +> e.g. in [[:​doc:​howto:​generic.sysupgrade]] I have updated it for the changes in LuCI page layouts and included previous version and Attitude Adjustment suffixes on each line. Is this a good way to do it? Or maybe repeat the whole procedure for both versions or should the Wiki only document the latest release?
 + --- //​adrianwadey 2014/01/24 10:17//
 +
 +
 +==== Should the pages added to the "​inbox"​ namespace follow existing namespaces ? ====
 +I just added a page about scripts to monitor the bandwidth, but since i don't know if there is a script namespace (see a related question), i just assumed that it existed so i added the path /​inbox/​script/​name_of_the_page . Was i wrong?
 + --- //pier4r 2014/09/21 21:03//
 +
 +
 +==== Are ad links and linking to modified proprietary firmware blobs allowed? ​ ====
 +> I ask this because of the official firmware links on [[:​toh:​tp-link:​tl-wr841nd]]'​s page. Three of the links are ad links that the uploader makes money off of which usually aren't allowed on forums or wiki pages. The fact that the links are to proprietary firmware blobs makes this much worse and likely illegal. Then there'​s the fact the the blobs are modified and re-hosted elsewhere which is also likely illegal. I suggest removing the links and just pointing to the relevant information on how to strip the firmware rather than potentially get the openwrt.org webmaster in trouble. --- //bracket 2014/11/02 18:39//
 +
 +
 +==== Possible solution for redundant pages? ====
 +I'm not a fan of deletions (unless the contributions are just spam),
 +now i think that 'no redundancy'​ is a feasible objective when there is
 +collaboration with humans with different wiki experiences (for instance,
 +one could now know if something already exists but it is not properly linked),
 +but on some topics i see a lot of effort scattered in different pages. ​
 +For example about vpn services.
 +
 +I thought that a solution that does not delete anything and neither
 +calls for a lot of effort (merging) could be move/copy those pages with a
 +label '​redundant'​.
 +
 +Like
 +<​file>​
 +namespace.vpn.openvpn.server
 +  # main page, unambiguous
 +namespace.vpn.openvpn.archive.1.server
 +  # first redundant page
 +namespace.vpn.openvpn.archive.2.server
 +  # second redundant page
 +namespace.vpn.openvpn.archive.3.server
 +  # third redundant page
 +</​file>​
 +
 +In this way '​redundant'​ effort is saved (that sometimes offers a different perspective),​
 +the namespace is cleaner and the work for merging is deferred to the future.
 +//Pier4r 2015-08-14//​
 +
 +===== Resolved questions =====
 +----
 +
 +==== Divide Table of Hardware by platform type ====
 +> OpenWrt is a deploy system for a lot of different platform, I believe that the new toh should be divided based on platform type. For example not all supported devices are wireless router, hence we should also categorize developer board and phone. What do you think? ​ --- //​[[claudyus84@gmail.com|Claudio]] 2010/01/15 11:30//
 +>> Some cathegorization has taken place in the new ToH. We have to offer these choices: "WiFi Router, Router, Travel Router, Travel Router - Battery powered, Single Board Computer, Modem, NAS, unknown, other"​. Many filtering options and datatables are available, see [[toh:​views:​start|Collection of views]]. --- //tmomas 2015/12/19 10:32//
 +
 +==== Report wiki issues ====
 +> Should problems regarding the wiki be handled by trac tickets or wiki internal? (read: that would introduce bugs & feature request sites on the wiki, maybe the use of a dpokuwiki ticket plugin, using the trac might fill up the ticketing a lot, dunno ..)  --- //kloschi 2009/05/31 16:14//
 +>> Report wiki issues either in the [[https://​forum.openwrt.org/​|OpenWrt forum]] (maybe the issue can be solved by the community?​),​ or [[about:​contact|contact a wiki admin]], if you are not able to solve it yourself. --- //tmomas 2015/12/19 10:28//
 +
 +==== Namespace full of spam? ====
 +I was just navigating the index when i found an (apparently) namespace full of spam:
 +"/​doc/​devel/​acne_cures"​ . How could we clean it?
 +> Just delete the spam. Alternatively:​ [[https://​wiki.openwrt.org/​about/​contact|Contact a wiki admin]] ​ --- //tmomas 2015/12/19 10:24//
 +
 +==== Where do I get the rights to upload pictures? ====
 +> I'm told that I don't have the rights to upload pictures in the media manager. How do I get the rights to do this? Whom to write an email? --- //taeuber 2015/05/31 22:01//
 +>> Use the media namespace. --- //jow 2015/06/04 09:59//
 +>>>​ This is what I still get: <​code>​ Upload to toh:tenda
 +Sorry, you don't have enough rights to upload files.</​code>​
 +>>>​ Possibly I misunderstood your answer. --- //taeuber 2015/06/04 10:53//
 +>>>>​ 1) To upload pictures, you need to be logged in.
 +>>>>​ 2) You are allowed to upload pictures only to the ''​media''​ namespace, i.e. you are allowed to upload to ''​media:​toh:​tenda'',​ but you are not allowed to upload to ''​toh:​tenda''​.
 +>>>>​ See also [[meta:​adding_images_to_openwrt_wiki]] ​ --- //tmomas 2015/12/19 10:08//
 +
 +==== Namespace "​doku"​ ====
 +> should the namespace for the actual documentation be called doku, documentation or just simple OpenWrt ?  ---
 +
 +>> changed to '​doc'​ as it is short for documentation //kloschi 2009/06/17 14:53 MEST//
 +
 +==== Unclear wiki page with FIXME image ====
 +> On [[inbox:​newswitchformat]] I found that the means of "5 is CPU" and below the tags ""​5*""​ and ""​5t""​ is undisclosed?​ Can I tag unclear wiki page with FIXME image followed by description?​
 +
 +>> yes  --- //​[[xm@subsignal.org|Jo-Philipp Wich]] 2010/01/12 22:59//
 +
 +==== Playground not working ====
 +> This would seem to be the only place to ask questions about the wiki.  Is that correct? ​ I cannot find a way to access the "​Gardeners Lounge >> playground"​. ​ When I click on the "​playground"​ link (above, on the page I currently have on my screen) I get a page that says:   "​This topic does not exist yet   ​You'​ve followed a link to a topic that doesn'​t exist yet. If permissions allow, you may create it by using the   ​Create this page button." ​  There is nothing I can find to click on in that screen ​ to create a page.  So how is a person supposed to use the playground? ​ --- //​[[L.Ewing@gmx.com|LloydEwing]] 2010/09/17 16:30//
 +
 +>> I created the page: [[meta:​playground]] --- //​Jo-Philipp Wich 2010/09/18 00:38//
 +
 +==== Force non-breaking spaces (example ​   ) ====
 +> Is there no way to force the wiki to leave blank characters in a line that is otherwise formatted? ​ An example would be a heading like the line below, where I want to use some space characters to separate the "​U10"​ name of the part from the rest of the part number in order to make it clear that U10 is not printed on the chip itself. ​ There has to be a way to do this but I can't find it on the syntax page or the quickbuttons.\\ %%==== Marvell 88W8500-BAN FF05081.2 ​  (U10) ====%%\\ (If you look at the source for this question you will see that even though this line was not supposed to be formatted, it removed the spaces before "​(U10)"​. ​ This was the only way I could format the question without ruining the ordered list.) The next time I add a section to the a page I think I will turn formatting off! :-/ Thanks. ​ --- //​[[L.Ewing@gmx.com|LloydEwing]] 2010/09/20 00:45//
 +
 +>> » No, there is no way to do it by default using DokuWiki, which is why people have created a few plugins: [[http://​www.dokuwiki.org/​plugin:​space|plugin:​space]],​ [[http://​www.dokuwiki.org/​plugin:​nbsp|plugin:​nbsp]],​ and [[http://​www.dokuwiki.org/​plugin:​tab|plugin:​tab]]. Of course, a wiki admin would have to install them. Alternatively,​ the wiki admin could allow HTML, and then, you could wrap a non-breaking space entity within an HTML ''​%%<​span>​%%''​ element (like this: ''​%%<​span>&​nbsp;</​span>​%%''​),​ but that would be just ugly.\\ The workaround for adding the non-breaking space would be to use the actual character instead of the HTML entity. For example, on Windows, you can type [[http://​www.fileformat.info/​info/​unicode/​char/​A0/​index.htm|ALT + 255]] to produce the " " character (see subheading example).\\ Anyway putting extra spaces in a anchored heading is not a good idea because the browser may treat non-breaking spaces in a URI as a phishing attack, so if you link to the anchor containing the character, the browser may freak out and go on a rampage (see "​[[http://​www.fileformat.info/​info/​unicode/​char/​A0/​index.htm|Do not use this character in domain names. Browsers are blacklisting it because of the potential for phishing.]]"​ warning).\\ Instead, however, if you want to specify optional text, you can use curly braces, which will indicate an optional argument, like this: ''​{OPTIONAL}''​ or ''​%%==== Marvell 88W8500-BAN FF05081.2 {U10} ====%%''​. --- // [[https://​forum.openwrt.org/​profile.php?​id=53265|XP1]] 2010/01/15 05:34 //
 +
 +>>>​ »» The wiki uses UTF8 encoding, so pasting stuff like ✓ just works OOTB. The non-breaking space does not :-(. The only work-around is to work with HTML. Which in case you want to mend a table, looks very messy in the raw text, but it does work! And I do not like the dokuwiki plugins, because many (most?) are not supported over a longer period of time. So when you want/have to update to a newer version of dokuwiki in a couple of years, most of your plugin-based stuff will just break, because there won't be a plugin version for that dokuwiki versions. ​ --- //orca 2011/08/30 02:29//
 +
 +
 +===== Proposals =====
 +
 +[[discussion:​improvement|OpenWrt Improvement]]
 +
 +----
 +==== Establish a common style guide ====
 +> I have commonly noticed many articles that mix cases. For example, the [[meta:​migrating|migrating]] article mixes the ''​Title Case''​ and ''​Sentence case''​. It is inconsistent and horrifying. There are a few other issues, such as formatting and text styles. We should establish a common style guide that standardizes the formatting, text, and case styles in use on the OpenWrt Wiki. --- //​[[https://​forum.openwrt.org/​profile.php?​id=53265|XP1]] 2011/06/05 05:34//
 +
 +>>​» ​ Wishful thinking. So far people don't even bother to follow really important stuff, like the [[meta:​template_device]] or the guideline to link to articles such as [[doc:​howto:​usb.storage]]. Instead they explain stuff again and again. A mess, which cannot be kept up to date. Compared to that, inconsistencies in style are .. not very important. ​ --- //orca 2011/08/30 02:06//
 +
 +==== Enhance CSS styling of the wiki ====
 +> When using the quote syntax, the wiki does not have the appropriate CSS to style the ''​blockquote''​s in a nested fashion. This is the CSS that this [[http://​www.dokuwiki.org/​tips:​customquoting#​colored_or_indented_quoting|DokuWiki page]] uses:
 +<code css>​blockquote
 +{
 +    border-left-color:​ #8cacbb;
 +    border-left-style:​ solid;
 +    border-left-width:​ 2px;
 +    padding-left:​ 3px;
 +}</​code>​
 +As you can see, using the ''​blockquote''​ style makes it so much easier to differentiate between quotes.\\ However, there are also other CSS enhancements that can be made. For example, the main headings should have a horizontal line style by default, like that [[http://​www.dokuwiki.org/​tips:​customquoting#​colored_or_indented_quoting|DokuWiki page]] and like Wikipedia, so that main headings have a line under them to visually and easily differentiate between other main headings. --- //​[[https://​forum.openwrt.org/​profile.php?​id=53265|XP1]] 2011/06/05 05:34//
 +
 +>>​»The wiki is for documentation only! If there is need for discussions,​ best use the forum. (Who likes the messy discussions pages in the wikipedia anyway?​) ​ --- //orca 2011/08/30 02:16//
 +
 +>>>​ Sorry but i don't agree. I like when a discussion in well related to the issue and the forum seems unrelated to the wiki. Besides, the wikipedia discussion pages are not messy, they just are different from a normal phpBB forum, it is a matter of approach. ​ --- //pier4r 2015/03/01 12:23//
 +
 +==== Implement page redirects ====
 +> It is a good idea for the OpenWrt wiki to implement page redirects. Pages that are moved or deprecated may break existing links on other pages. This forces editors to scrutinize and tirelessly make corrective edits for several other pages if a main page is moved. Here are the solutions for page redirection on DokuWiki: [[http://​www.dokuwiki.org/​faq:​redirect]]. --- //​[[https://​forum.openwrt.org/​profile.php?​id=53265|XP1]] 2011/06/05 05:34//
 +
 +>>» We have redirects: ​ http://​www.dokuwiki.org/​plugin:​redirect ​ --- //orca 2011/08/30 02:16//
 +
 +==== Corrective article name changes ====
 +> Some articles have terrible or lousy names, and some may even require name corrections.
 +
 +>> » Yes, I agree! I suggest to collect concrete name-changes here or in the forum. Admin can then move the pages and place some redirects to not brake deep links from the outside world. ​ --- //orca 2011/08/30 02:17//
 +
 +> For example of a minor correction, as a start, I propose that this current article [[meta:​discussion|discussion]] be renamed to [[meta:​discussion|discussions]]. --- //​[[https://​forum.openwrt.org/​profile.php?​id=53265|XP1]] 2011/06/05 05:34//
 +>> » Any other, more important suggestions? ​ --- //orca 2011/08/30 02:17//
 +
 +==== Automate the TOH with DokuWiki '​data'​ Plugin ====
 +It seems the OpenWrt wiki runs on DocuWiki; the [[http://​www.dokuwiki.org/​plugin:​data|data]] plugin could be used to automate the Table of Hardware (TOH) to be generated automatically from structured data on hardware detail pages (like the sidebars in Wikipedia). This plugin requires some sqlite support, might not be well maintained, and might have a poor impact on site performance... but could save lots and lots of duplicated effort. I think the division-by-architecture or type could implemented with tags and/or separate table queries?
 +
 +Could be combined with the [[http://​www.dokuwiki.org/​plugin:​bureaucracy|bureaucracy]] plugin to create a single form for entering information about a new hardware device.
 +
 + --- //bnewbold 2012/05/29 21:24//
 +
 +**ToH is WIP** (status as of 02.05.2015),​ see https://​forum.openwrt.org/​viewtopic.php?​id=56521
 +
 +  * Step 1: Cleanup current ToH -> in progress
 +  * Step 2: Implement new ToH by means of data-plugin (as suggested above) -> tbd
 +    * Prerequisite:​ Install data-plugin -> done
 +    * create dataentry pages for each device -> tbd
 +  * Step 3: Use of bureaucracy plugin (as suggested above) for new dataentries -> tbd
 +
 +
 + --- //tmomas 2015/05/02 20:04//
 +
 +New [[toh:​start|ToH]] is implemented and running since end of August 2015.
 +
 + --- //tmomas 2015/12/19 10:54//
 +==== Allow firmware images to be uploaded like pictures ====
 +
 +It would be great to be able to upload firmware images or parts of it. This way it might be possible for someone who wants to get back to original to restore the bootloader or the entire firmware.
 +
 + --- //taeuber 2012/10/01 22:42//
 +
 +==== About damaged and urecoverable hardware ====
 +**Advertise people somewhere**,​ when they have a damaged board (unrecoverable),​ invite them to remove the processor an make a **high quality photo of this part (the soldering balls)**, before throwing it to the trash. It's very useful for other people to identify pinouts (like JTAG), specially on CPUs/SoCs without datasheet available. ​
 +
 +We can **trace** usb pins or known JTAG pins but we don't know where they end without removing the processor, The same for the opposite, we can know where they start at the SoC but not where they end in a new unknown board with the same SoC. Did you catch the idea?
 +
 +Where should we put this advertisement?​
 +
 + --- //danitool 2012/10/09 11:06//
 +
 +===== Issues =====
 +I would like to introduce ​ a new language flag in the sidebar of the home page in order to points to newly translated pages but I cannot find anything explaining me how to do it ?
 +
 +--- //buntalo 2013-02-07//​
 +
 +Only admins can enable new languages. In which language would you like to translate pages into? Please also consider contributing to LuCI: http://​i18n.luci.subsignal.org/​pootle/​
 +
 +---- //orca 2013-05-19//​
 +
 +===== Interwiki links =====
 +The file ''/​etc/​dokuwiki/​interwiki.local.conf''​ on the server this dokuwiki runs on, could be augmented:<​code>​
 +deb       ​http://​packages.debian.org/​search?​searchon=names&​keywords={NAME}
 +debs      http://​packages.debian.org/​stable/​{NAME} or better use release numbers:
 +deb7      http://​packages.debian.org/​wheezy/​{NAME}
 +deb8      http://​packages.debian.org/​jessy/​{NAME}
 +debt      http://​packages.debian.org/​testing/​{NAME}
 +debu      http://​packages.debian.org/​unstable/​{NAME}
 +</​code>​
 +
 +Would be cool to have on pages like [[doc/​uci/​transmission]],​ where you need to install additional packages on the remote machine. Would also be cool for [[doc/​howto/​buildroot.exigence]] article as well.