It seems like the doc for the Web Admin interface in the User Guide are somewhat out of date - in that they apparently refer to an older arrangement of the left-hand menu.
Are there any plans to update this?
–
Martin Davis
OpenGeo - http://opengeo.org
Expert service straight from the developers.
On Sun, Mar 18, 2012 at 6:50 PM, Martin Davis <mdavis@anonymised.com> wrote:
It seems like the doc for the Web Admin interface in the User Guide are somewhat out of date - in that they apparently refer to an older arrangement of the left-hand menu.
Are there any plans to update this?
Not that I know of, nobody has been focusing on the user documentation in a while, if
you except updates to the existing docs when new functionality lands (and even that
does not happens always).
I have been meaning to discuss the idea that in order for a change to land it does not
need to include only the change and a test, but also docs, yet, given that it’s hard already
to ask people to write a test (which is, all in all, still coding) I don’t know what will happen
if we ask also docs.
I’m partial to software that’s working (and stays that way) but not documented instead of
software that’s documented, but broken, but it’s just me :-p
Cheers
Andrea
Ing. Andrea Aime
GeoSolutions S.A.S.
Tech lead
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 962313
mob: +39 339 8844549
http://www.geo-solutions.it
http://geo-solutions.blogspot.com/
http://www.youtube.com/user/GeoSolutionsIT
http://www.linkedin.com/in/andreaaime
http://twitter.com/geowolf
On Sun, Mar 18, 2012 at 3:02 PM, Andrea Aime
<andrea.aime@anonymised.com> wrote:
On Sun, Mar 18, 2012 at 6:50 PM, Martin Davis <mdavis@anonymised.com> wrote:
It seems like the doc for the Web Admin interface in the User Guide are
somewhat out of date - in that they apparently refer to an older arrangement
of the left-hand menu.Are there any plans to update this?
Not that I know of, nobody has been focusing on the user documentation in a
while, if
you except updates to the existing docs when new functionality lands (and
even that
does not happens always).I have been meaning to discuss the idea that in order for a change to land
it does not
need to include only the change and a test, but also docs, yet, given that
it's hard already
to ask people to write a test (which is, all in all, still coding) I don't
know what will happen
if we ask also docs.
+1.
I wasn’t intending to provoke any philosophical debate! 8^) I was just confirming that this something that needs doing, and if I was to work on it (a bit…) I won’t be duplicating any effort.
For the record, I agree that functionality shouldn’t be held back for lack of docs. Although some gentle encouragement to move to the working/documented state where possible can only be a good thing.
On Sun, Mar 18, 2012 at 11:02 AM, Andrea Aime <andrea.aime@anonymised.com> wrote:
On Sun, Mar 18, 2012 at 6:50 PM, Martin Davis <mdavis@anonymised.com> wrote:
It seems like the doc for the Web Admin interface in the User Guide are somewhat out of date - in that they apparently refer to an older arrangement of the left-hand menu.
Are there any plans to update this?
Not that I know of, nobody has been focusing on the user documentation in a while, if
you except updates to the existing docs when new functionality lands (and even that
does not happens always).I have been meaning to discuss the idea that in order for a change to land it does not
need to include only the change and a test, but also docs, yet, given that it’s hard already
to ask people to write a test (which is, all in all, still coding) I don’t know what will happen
if we ask also docs.I’m partial to software that’s working (and stays that way) but not documented instead of
software that’s documented, but broken, but it’s just me :-p
–
Martin Davis
OpenGeo - http://opengeo.org
Expert service straight from the developers.
On Sun, Mar 18, 2012 at 12:02 PM, Andrea Aime <andrea.aime@anonymised.com> wrote:
On Sun, Mar 18, 2012 at 6:50 PM, Martin Davis <mdavis@anonymised.com> wrote:
It seems like the doc for the Web Admin interface in the User Guide are somewhat out of date - in that they apparently refer to an older arrangement of the left-hand menu.
Are there any plans to update this?
Not that I know of, nobody has been focusing on the user documentation in a while, if
you except updates to the existing docs when new functionality lands (and even that
does not happens always).I have been meaning to discuss the idea that in order for a change to land it does not
need to include only the change and a test, but also docs, yet, given that it’s hard already
to ask people to write a test (which is, all in all, still coding) I don’t know what will happen
if we ask also docs.
What about changes on trunk? +1 on docs being a requirement for the stable branch but I wonder if it is too much to ask for people working on the trunk. Instead perhaps we could have a policy that involves not being able to release trunk or make it stable until features are documented.
Often the way our team does work is that one fo the devs does all the development until it is stable and then passes it over to someone else to document. Example, all the recent workspace specific changes that have recently happened on trunk. I have finished the development for the most part and Mike is working on documentation as we speak. And it much easier for him to work with the changes by being able to pull down nightly builds of trunk.
I’m partial to software that’s working (and stays that way) but not documented instead of
software that’s documented, but broken, but it’s just me :-pCheers
Andrea–
Ing. Andrea Aime
GeoSolutions S.A.S.
Tech leadVia Poggio alle Viti 1187
55054 Massarosa (LU)
Italyphone: +39 0584 962313
fax: +39 0584 962313
mob: +39 339 8844549http://www.geo-solutions.it
http://geo-solutions.blogspot.com/
http://www.youtube.com/user/GeoSolutionsIT
http://www.linkedin.com/in/andreaaime
http://twitter.com/geowolf
This SF email is sponsosred by:
Try Windows Azure free for 90 days Click Here
http://p.sf.net/sfu/sfd2d-msazure
Geoserver-devel mailing list
Geoserver-devel@anonymised.comsts.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
–
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.
On Mon, Mar 19, 2012 at 2:58 PM, Justin Deoliveira <jdeolive@anonymised.com.1501…> wrote:
On Sun, Mar 18, 2012 at 12:02 PM, Andrea Aime <andrea.aime@anonymised.com> wrote:
On Sun, Mar 18, 2012 at 6:50 PM, Martin Davis <mdavis@anonymised.com> wrote:
It seems like the doc for the Web Admin interface in the User Guide are somewhat out of date - in that they apparently refer to an older arrangement of the left-hand menu.
Are there any plans to update this?
Not that I know of, nobody has been focusing on the user documentation in a while, if
you except updates to the existing docs when new functionality lands (and even that
does not happens always).I have been meaning to discuss the idea that in order for a change to land it does not
need to include only the change and a test, but also docs, yet, given that it’s hard already
to ask people to write a test (which is, all in all, still coding) I don’t know what will happen
if we ask also docs.What about changes on trunk? +1 on docs being a requirement for the stable branch but I wonder if it is too much to ask for people working on the trunk. Instead perhaps we could have a policy that involves not being able to release trunk or make it stable until features are documented.
Often the way our team does work is that one fo the devs does all the development until it is stable and then passes it over to someone else to document. Example, all the recent workspace specific changes that have recently happened on trunk. I have finished the development for the most part and Mike is working on documentation as we speak. And it much easier for him to work with the changes by being able to pull down nightly builds of trunk.
Makes sense, to a point.
Worried about the following:
Cheers
Andrea
Ing. Andrea Aime
GeoSolutions S.A.S.
Tech lead
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
fax: +39 0584 962313
mob: +39 339 8844549
http://www.geo-solutions.it
http://geo-solutions.blogspot.com/
http://www.youtube.com/user/GeoSolutionsIT
http://www.linkedin.com/in/andreaaime
http://twitter.com/geowolf