From: Vesa <di...@nb...> - 2014-02-20 20:13:18
|
On 02/20/2014 10:02 PM, perret.yannick wrote: > Le 19/02/2014 19:27, Tres Finocchiaro a écrit : >> I planed to submit a HOW-TO for this plugin for the users' wiki but >> still not get the time to do it. >> >> >> Would it be appropriate to have important notes about plugins added to >> the "Plugin Description" area? >> >> Inline image 1 >> > I looked for a place in the plugin description to include a more > complete help but can't find one. When I made this plugin I checked in > other plugins but they all seems to put very short information in this > field. > Maybe include an URL to a description/help page but 1. it would imply to > change the plugin code if this page moves and 2. text in this area is > not clickable nor selectable for copy/paste (at least under linux). > I think you're both overthinking this - we can just include a page in the wiki, plus a forum thread on the SF forums tutorial section, that should be enough for any plugin or feature in general. I intend to write short tutorials for my graph-based plugins, too. In fact it might be a good idea to write a short tutorial about every new feature in 1.0.0, and then gather all of them together - kind of like a crash course on all the new features of 1.0.0. Even things that don't need a tutorial can be added there, just to notify people that this thing is possible now. |