Hi Jody.

> A question; is this a url to the published documentation (ie an
> alternative to http://gridlock.openplans.org/geoserver/1.7.x/doc/user)
> or is it an svn repository for working on the docs?

I think docs.geoserver.org would probably be a link to the built docs (i.e. 
gridlock).  The source docs would continue to be accessed via svn in the same 
way that code is.

> However I really like the idea of keeping our
> docs from release to release.

The example I used during the meeting today was the KML reflector, whose syntax 
changed in version 1.7.1.  If I were running 1.6.5, and I only had links to the 
latest docs, I would find incorrect syntax.  This also alleviates the need for 
tiresome lists like "if you are running _this_ version, do _that_".

> Sounds good; We may want to change the examples in the writing
> guidelines from confluence to ReStructuredText.

This is definitely needed, and a documentation meta-guide was started here (no 
built version exists yet):

https://svn.codehaus.org/geoserver/branches/1.7.x/doc/guide/source/


Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org


Jody Garnett wrote:
> Thanks for the update.
> 
>> Issues that come to mind are:
>>
>> 1) Setting up a permanent repository for versioned docs.
>>    We discussed in the IRC meeting today [6] to have the docs possibly 
>> hosted at http://docs.geoserver.org/x.y.z
> 
> A question; is this a url to the published documentation (ie an
> alternative to http://gridlock.openplans.org/geoserver/1.7.x/doc/user)
> or is it an svn repository for working on the docs?
> 
>> 2) Deprecating the current docs
>>    Confluence won't be going away, but the current docs (hosted in the 
>> GEOSDOC space) should possibly have a notice posted saying that they are not 
>> the current version of the docs.  I was thinking a global banner over the 
>> top, but we can hammer out details.  Also, I hope the wiki will morph into a 
>> "community" docs section, where anyone can still contribute, but the work 
>> will need to be peer reviewed before it becomes part of the official 
>> documentation.
> 
> I am just watching the eclipse community migrate in the other
> direction; their official docs now point to the appropriate wiki page
> for the latest version.  However I really like the idea of keeping our
> docs from release to release.
> 
>> This email is to get the discussion started.  What 
>> questions/comments/reservations do you have?
> 
> Sounds good; We may want to change the examples in the writing
> guidelines from confluence to ReStructuredText.
> 
> Jody

------------------------------------------------------------------------------
_______________________________________________
Geoserver-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geoserver-devel

Reply via email to