Talk:FGAddon: Difference between revisions

Jump to navigation Jump to search
m
Sort out indentation
(Cost analysis.)
m (Sort out indentation)
Line 4: Line 4:
The [[FGAddon]] article could greatly benefit from being reviewed with a focus on getting rid of/generalizing explicit URLs (or even git instructions) in favor of using templates that encapsulate any URL/git specifics, so that things can be more easily updated in the future. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 03:01, 20 September 2015 (EDT)
The [[FGAddon]] article could greatly benefit from being reviewed with a focus on getting rid of/generalizing explicit URLs (or even git instructions) in favor of using templates that encapsulate any URL/git specifics, so that things can be more easily updated in the future. --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 03:01, 20 September 2015 (EDT)


:: Is there a listing or category page for such templates?  I haven't found where these are collected, and cannot find the relevant template.  The SF URLs are very diverse in this article, e.g.:
: Is there a listing or category page for such templates?  I haven't found where these are collected, and cannot find the relevant template.  The SF URLs are very diverse in this article, e.g.:


<syntaxhighlight lang=bash>
<syntaxhighlight lang="bash">
svn+ssh://<username>@svn.code.sf.net/p/flightgear/fgaddon/trunk/Aircraft/
svn+ssh://<username>@svn.code.sf.net/p/flightgear/fgaddon/trunk/Aircraft/
svn+ssh://<username>@svn.code.sf.net/p/flightgear/fgaddon/trunk/Aircraft/DaSH
svn+ssh://<username>@svn.code.sf.net/p/flightgear/fgaddon/trunk/Aircraft/DaSH
Line 22: Line 22:
</syntaxhighlight>
</syntaxhighlight>


:: Some of these URLs are highly specific to the very detailed and reqired instructions on the page.  The parts in angular brackets <> should be presented in these brackets on the page to indicate that the reader replaces it with the relevant value.  So these are not followable URLs anyway.  And can templates be used in the <nowiki><syntaxhighlight></nowiki> tags?  Note that none of these are for the SF web interface, for which all the templates I've seen so far are for.
: Some of these URLs are highly specific to the very detailed and reqired instructions on the page.  The parts in angular brackets <> should be presented in these brackets on the page to indicate that the reader replaces it with the relevant value.  So these are not followable URLs anyway.  And can templates be used in the <nowiki><syntaxhighlight></nowiki> tags?  Note that none of these are for the SF web interface, for which all the templates I've seen so far are for.


:: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:58, 27 October 2015 (EDT)
: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 13:58, 27 October 2015 (EDT)


::: The idea can be seen at [http://wiki.flightgear.org/Template:Git_clone] - i.e. originally, we were hoping to grow a library of templates that can be parameterized, not just in terms of "actions" (clone, update/pull, push etc), but also in front-end terms - e.g. by adding screen shots for different front-ends and dynamically showing the matching UI front-end (or shell instructions). ::: The whole thing was inspired by the discussion at [[Talk:Development Workflow]]. For instance, for NetBeans:  
:: The idea can be seen at [http://wiki.flightgear.org/Template:Git_clone] - i.e. originally, we were hoping to grow a library of templates that can be parameterized, not just in terms of "actions" (clone, update/pull, push etc), but also in front-end terms - e.g. by adding screen shots for different front-ends and dynamically showing the matching UI front-end (or shell instructions). ::: The whole thing was inspired by the discussion at [[Talk:Development Workflow]]. For instance, for NetBeans: [[File:Netbeans-staying-up2date.png|thumb|git pull via NetBeans]]
[[File:Netbeans-staying-up2date.png|thumb|git pull via NetBeans]]--[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:05, 27 October 2015 (EDT)
:: --[[User:Hooray|Hooray]] ([[User talk:Hooray|talk]]) 14:05, 27 October 2015 (EDT)


:::: In an abstract way, I can see how this would be useful.  In a concert way - i.e. the fine details of how this should be implemented - I cannot see this yet.  I need some time to think about it.  The main issue is that the exact commands to type, which are essential and without which the article cannot function, are very much specific to the prompt UI of svn, git, and git-svn.  Each GUI does this differently, packaging a number of the commands into one menu entry or button.  I think for this task that the GUI diversity is insane, and we cannot provide full coverage, and that the major focus of the article should be the command line.
::: In an abstract way, I can see how this would be useful.  In a concert way - i.e. the fine details of how this should be implemented - I cannot see this yet.  I need some time to think about it.  The main issue is that the exact commands to type, which are essential and without which the article cannot function, are very much specific to the prompt UI of svn, git, and git-svn.  Each GUI does this differently, packaging a number of the commands into one menu entry or button.  I think for this task that the GUI diversity is insane, and we cannot provide full coverage, and that the major focus of the article should be the command line.


:::: For URL templates, some of these may have a slight advantage.  However look at history - of the Gitoriuos to SF transition. If we had had Gitorious templates, these and there surrounding instructions would be hopelessly out of date and nothing could be done in the template to fix it.  The fixing action would be to search for all instances in the wiki and replace, and this would be the same amount of work with or without the template.  The other situation where a template would be useful is if the SF url changes.  However this might require a template change and search+fix all instances anyway.  Also the SF urls are pretty much fixed in stone and very unlikely to change.  So template+template usage costs may be higher than pure command+url usage.  From a pure cost analysis perspective, I'm not convinced of the benefit yet.
::: For URL templates, some of these may have a slight advantage.  However look at history - of the Gitoriuos to SF transition. If we had had Gitorious templates, these and there surrounding instructions would be hopelessly out of date and nothing could be done in the template to fix it.  The fixing action would be to search for all instances in the wiki and replace, and this would be the same amount of work with or without the template.  The other situation where a template would be useful is if the SF url changes.  However this might require a template change and search+fix all instances anyway.  Also the SF urls are pretty much fixed in stone and very unlikely to change.  So template+template usage costs may be higher than pure command+url usage.  From a pure cost analysis perspective, I'm not convinced of the benefit yet.


:::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:22, 28 October 2015 (EDT)
::: [[User:Bugman|Bugman]] ([[User talk:Bugman|talk]]) 11:22, 28 October 2015 (EDT)

Navigation menu