forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ross Gardler <rgard...@apache.org>
Subject Re: problem with docs at forrest.apache.org/docs/dev/
Date Tue, 05 Apr 2005 08:55:57 GMT
David Crossley wrote:
> David Crossley wrote:
> 
>>David Crossley wrote:
>>
>>>David Crossley wrote:
>>>
>>>>David Crossley wrote:
> 
> [snip]
> 
>>>>>Assuming that we don't want to version the top-level docs.
>>>>
>>>>Is that a legitimate assumption? It would change our layout if we do.
>>>>I don't know the answer yet either.
>>>>
>>>>
>>>>>f.a.o/ ... the top-level docs, from trunk/site-author 
>>>>>f.a.o/docs/ ... is .htaccess to redirect to current release docs.
>>>>>f.a.o/docs/0.6/ ... from the forrest_06_branch (*)
>>>>>f.a.o/docs/0.7/ ... from the forrest_07_branch, when it is released
>>>>>f.a.o/docs/0.8/ ... the next development, from future trunk/docs-author/
>>>
>>>Let us see what the other solution would be.
>>>(Say that "current release" is 0.7)
>>>
>>>f.a.o/ ... the top-level docs, .htaccess to redirect to 0.7 top-level
>>>f.a.o/docs/ ... .htaccess to redirect to 0.7/docs/
>>>f.a.o/0.6/ ... from the forrest_06_branch
>>>f.a.o/0.6/docs/ ... from the forrest_06_branch
>>>f.a.o/0.7/ ... from the forrest_07_branch/site-author/
>>>f.a.o/0.7/docs/ ... from the forrest_07_branch/docs-author/
>>>f.a.o/0.8/ ... the next development, from the trunk/site-author/
>>>f.a.o/0.8/docs/ ... from the trunk/docs-author/
> 
> 
> Ross Gardler wrote in another thread:
> 
>>>Date: Mon Apr  4 15:13:48 2005
>>>URL: http://svn.apache.org/viewcvs?view=rev&rev=160109
>>>Log:
>>>Deployment of org.apache.forrest.plugin.OpenOffice.org plugin (deployed by
>>>'deploy' target of plugin build script)
>>>
>>>Added:
>>>   forrest/site/plugins/docs/org.apache.forrest.plugin.OpenOffice.org/
>>>   forrest/site/plugins/docs/org.apache.forrest.plugin.OpenOffice.org/skin/
>>>   forrest/site/plugins/docs/org.apache.forrest.plugin.OpenOffice.org/skin/screen.css
>>
>>OK, I'm experimenting with auto generating plugin docs, so you may see a
>>few of these kinds of commits over then next week as I grab an hour here
>>an hour there. But I have some questions.
>>
>>I've not really kept up to date with the docs discussions, either the
>>first round or this round. I'm afraid they slipped underneath my "full
>>attention" threshold. Now I find I should have kept up.
>>
>>How do people suggest I integrate the plugin docs with the main website
>>docs?
> 
> 
> If they went under docs/plugins/$plugin-name/
> then they will fit better with the versioning system
> described above.

OK, that's where I'll put them then.

I assume we want to SVN them into place in the way I've prototyped (see 
commit above), rather than duplicate the xdocs in the docs-author site.

Note, that the point to link into these docs will therefore be 
docs/plugins/index.html. That page will contain a link to all the 
individual plugin documents.

One more thing that struck me about plugins. We have a potential 
nightmare with versioning docs. There are two version numbers we can 
work against, the Forrest one and the plugin one. The idea is that 
plugins can be release independently of Forrest.

So we could have Forrest 0.7 with OK for versions 0.1, 0.2 and 0.3 of 
plugin X, whilst 0.4 will only work in Forrest 0.8.

Do we want to worry about maintaining docs for each version of the 
plugin as well? For example

f.o.a/0.7/docs/plugins/o.a.f.p.PLUGINNAME/0.1
f.o.a/0.7/docs/plugins/o.a.f.p.PLUGINNAME/0.2
f.o.a/0.7/docs/plugins/o.a.f.p.PLUGINNAME/0.3
f.o.a/0.8/docs/plugins/o.a.f.p.PLUGINNAME/0.4

Note that in this case, if 0.4 of the plugin works in 0.7 of Forrest we 
should also have the 0.4 plugin docs in the 0.7 branch. This starts to 
get horribly complicated.

Ross

Mime
View raw message