As the transition towards Sphinx docs continues...
I was looking at our documentation guide[1], a meta-document about the GeoServer docs, and I was thinking that it really isn't all that version specific. This is fine, as I don't think best practices change according to the version. (Can you think of a counter-example?) So, I was wondering if people thought it made sense to put the docguide somewhere else. I can't quite figure out where that would be, but I wanted to ask to see if people had suggestions. This would have the effect of preventing redundancy (the way things are currently, every change should be copied on each active branch + trunk).
[1] http://docs.geoserver.org/1.7.x/docguide/index.html
Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org
I would say if it is not version specific we can just store it and maintain it on trunk. It will get copied over to branches but I don't seen an issue with that, as long as the trunk version of the one that gets maintained, and the one that gets published.
-Justin
Mike Pumphrey wrote:
As the transition towards Sphinx docs continues...
I was looking at our documentation guide[1], a meta-document about the GeoServer docs, and I was thinking that it really isn't all that version specific. This is fine, as I don't think best practices change according to the version. (Can you think of a counter-example?) So, I was wondering if people thought it made sense to put the docguide somewhere else. I can't quite figure out where that would be, but I wanted to ask to see if people had suggestions. This would have the effect of preventing redundancy (the way things are currently, every change should be copied on each active branch + trunk).
[1] http://docs.geoserver.org/1.7.x/docguide/index.html
Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org
------------------------------------------------------------------------------
OpenSolaris 2009.06 is a cutting edge operating system for enterprises looking to deploy the next generation of Solaris that includes the latest innovations from Sun and the OpenSource community. Download a copy and enjoy capabilities such as Networking, Storage and Virtualization. Go to: http://p.sf.net/sfu/opensolaris-get
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
Perfect. Docguide is copied to trunk, and I edited the Hudson job to build that as well.
http://docs.geoserver.org/trunk/docguide/
Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org
Justin Deoliveira wrote:
I would say if it is not version specific we can just store it and maintain it on trunk. It will get copied over to branches but I don't seen an issue with that, as long as the trunk version of the one that gets maintained, and the one that gets published.
-Justin
Mike Pumphrey wrote:
As the transition towards Sphinx docs continues...
I was looking at our documentation guide[1], a meta-document about the GeoServer docs, and I was thinking that it really isn't all that version specific. This is fine, as I don't think best practices change according to the version. (Can you think of a counter-example?) So, I was wondering if people thought it made sense to put the docguide somewhere else. I can't quite figure out where that would be, but I wanted to ask to see if people had suggestions. This would have the effect of preventing redundancy (the way things are currently, every change should be copied on each active branch + trunk).
[1] http://docs.geoserver.org/1.7.x/docguide/index.html
Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org
------------------------------------------------------------------------------
OpenSolaris 2009.06 is a cutting edge operating system for enterprises looking to deploy the next generation of Solaris that includes the latest innovations from Sun and the OpenSource community. Download a copy and enjoy capabilities such as Networking, Storage and Virtualization. Go to: http://p.sf.net/sfu/opensolaris-get
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
I agree. We should treat the docs just like code. Having them live on trunk, instead of starting fresh each time, is in my view the way to keep them alive. We can always hide or remove abandoned docs, as we do abandoned code.
Justin Deoliveira wrote:
I would say if it is not version specific we can just store it and maintain it on trunk. It will get copied over to branches but I don't seen an issue with that, as long as the trunk version of the one that gets maintained, and the one that gets published.
--
Ben Caradoc-Davies <Ben.Caradoc-Davies@anonymised.com>
Software Engineer, CSIRO Exploration and Mining
Australian Resources Research Centre
26 Dick Perry Ave, Kensington WA 6151, Australia