On Feb 16, 2008, at 3:09 AM, David Blevins wrote:
On Feb 15, 2008, at 9:24 AM, David Jencks wrote:
I think we should work hard to make the documentation reference
live svn content using the snippet plugin. However my initial
attempts
http://cwiki.apache.org/confluence/display/GMOxDOC21/Plugin+infrastructure
I've gone ahead and added this snippet url prefix:
geronimo/ ---> http://svn.apache.org/repos/asf/geronimo/
Should allow us to at least get started. I updated your page to use
it.
Created another simple example here:
http://cwiki.apache.org/confluence/display/GMOxSBOX/Snippet+Example
appear to indicate that a confluence admin has to set up at least
one configured url prefix. AFAICT I'm not a confluence admin and
if I was I'd still have no idea how to set this up.
Also I'm really not sure what an appropriate prefix would be or
what the scope for which it applies is. I certainly want to be
able to include snippets from server, plugins, etc etc but wonder
if including e.g branch info in the prefix would help migrating
docs from one version to another. Does anyone have a clue what
"best practice" or "anything that works" might be?
Not real sure about branch/tag/trunk best practices. We could add
prefixes for each version then just update the urls associated with
the prefixes when those tag.
Well, pointing to "trunk" files certainly doesn't seem correct. Sure
recipe for Release 2.1 docs getting totally out of whack. I'd vote for
tags/2.1. Note that this means for 2.1 documentation, the snippet
plugin is basically a cut-and-paste convenience...
--kevan
