[Geoserver-devel] updates to some developer docs

Hi all,

I have spent some time over the last few days porting some of our developer docs to sphinx. In particular the quickstarts. Feedback appreciated:

http://docs.geoserver.org/1.7.x/developer/quickstart/index.html
http://docs.geoserver.org/1.7.x/developer/maven-guide/index.html
http://docs.geoserver.org/1.7.x/developer/eclipse-guide/index.html

Basically what I did was instead of having two quickstarts, one for maven one for eclipse, i just did one unified one. And then broke out separate "guides" for doing stuff with maven and eclipse.

I figured the previous versions on the wiki were trying to do too much by being both a step by step quickstart, and a reference of how to do other stuff.

-Justin

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

Justin Deoliveira ha scritto:

Hi all,

I have spent some time over the last few days porting some of our developer docs to sphinx. In particular the quickstarts. Feedback appreciated:

http://docs.geoserver.org/1.7.x/developer/quickstart/index.html
http://docs.geoserver.org/1.7.x/developer/maven-guide/index.html
http://docs.geoserver.org/1.7.x/developer/eclipse-guide/index.html

Basically what I did was instead of having two quickstarts, one for maven one for eclipse, i just did one unified one. And then broke out separate "guides" for doing stuff with maven and eclipse.

I figured the previous versions on the wiki were trying to do too much by being both a step by step quickstart, and a reference of how to do other stuff.

Looks good.

Maven version wise, I've been using 2.1 for quite some time, not sure
what other people are using but I sort of assumed everybody was using
it already? :slight_smile:
(http://docs.geoserver.org/1.7.x/developer/tools.html#tools)

"Most maven commands can be run from the root the source tree". One thing that tricks me is that sometimes I forget to "cd src". Might
be something other trip into."

"While the clean command is not necessary, it is recommented."
I find I did not have a need for cleaning _if_ I keep eclipse compiled classes out of the way (at least, I did not need a full clean in over
a week). But I guess we can work on this one when the patch
http://jira.codehaus.org/browse/MECLIPSE-581 gets applied to the official Eclipse maven plugin.

"Running the web module with Jetty": it would be nice to also have
this sample command line:
mvn jetty:run -DGEOSERVER_DATA_DIR /path/to/custom/data/dir

At least, that's what I find handy when I run from command line,
it spares one from having to install the datadir locally

Cheers
Andrea

--
Andrea Aime
OpenGeo - http://opengeo.org
Expert service straight from the developers.

Side note: the eclipse / maven split was done for two reasons:
1. ease of starting off new people
2. seperating out the eclipse docs made it look not like an eclipse
only project (ie we could have netbeans)

Perhaps we can put a note at the end asking a NetBeans volunteer to
help write docs.
Jody

On Mon, Jul 6, 2009 at 5:44 PM, Justin Deoliveira<jdeolive@anonymised.com> wrote:

Hi all,

I have spent some time over the last few days porting some of our
developer docs to sphinx. In particular the quickstarts. Feedback
appreciated:

http://docs.geoserver.org/1.7.x/developer/quickstart/index.html
http://docs.geoserver.org/1.7.x/developer/maven-guide/index.html
http://docs.geoserver.org/1.7.x/developer/eclipse-guide/index.html

Basically what I did was instead of having two quickstarts, one for
maven one for eclipse, i just did one unified one. And then broke out
separate "guides" for doing stuff with maven and eclipse.

I figured the previous versions on the wiki were trying to do too much
by being both a step by step quickstart, and a reference of how to do
other stuff.

-Justin

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------------------------------------------------------
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel

Thanks for the feedback Andrea, I updated the docs are per your suggestions, except for the bit about clean. Once we have finalized how the eclipse directory is managed, or once having it separate is the default we can remove that bit.

Andrea Aime wrote:

Justin Deoliveira ha scritto:

Hi all,

I have spent some time over the last few days porting some of our developer docs to sphinx. In particular the quickstarts. Feedback appreciated:

http://docs.geoserver.org/1.7.x/developer/quickstart/index.html
http://docs.geoserver.org/1.7.x/developer/maven-guide/index.html
http://docs.geoserver.org/1.7.x/developer/eclipse-guide/index.html

Basically what I did was instead of having two quickstarts, one for maven one for eclipse, i just did one unified one. And then broke out separate "guides" for doing stuff with maven and eclipse.

I figured the previous versions on the wiki were trying to do too much by being both a step by step quickstart, and a reference of how to do other stuff.

Looks good.

Maven version wise, I've been using 2.1 for quite some time, not sure
what other people are using but I sort of assumed everybody was using
it already? :slight_smile:
(http://docs.geoserver.org/1.7.x/developer/tools.html#tools)

"Most maven commands can be run from the root the source tree". One thing that tricks me is that sometimes I forget to "cd src". Might
be something other trip into."

"While the clean command is not necessary, it is recommented."
I find I did not have a need for cleaning _if_ I keep eclipse compiled classes out of the way (at least, I did not need a full clean in over
a week). But I guess we can work on this one when the patch
http://jira.codehaus.org/browse/MECLIPSE-581 gets applied to the official Eclipse maven plugin.

"Running the web module with Jetty": it would be nice to also have
this sample command line:
mvn jetty:run -DGEOSERVER_DATA_DIR /path/to/custom/data/dir

At least, that's what I find handy when I run from command line,
it spares one from having to install the datadir locally

Cheers
Andrea

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

Yeah, I actually think having them separate is easier for new people since the old docs kind of tried to be a quickstart and a reference at the same time.

Good point netbeans though. It would be great if one of the developers using netbeans could contribute a "Netbeans Guide", or any other IDE for that matter.

Jody Garnett wrote:

Side note: the eclipse / maven split was done for two reasons:
1. ease of starting off new people
2. seperating out the eclipse docs made it look not like an eclipse
only project (ie we could have netbeans)

Perhaps we can put a note at the end asking a NetBeans volunteer to
help write docs.
Jody

On Mon, Jul 6, 2009 at 5:44 PM, Justin Deoliveira<jdeolive@anonymised.com> wrote:

Hi all,

I have spent some time over the last few days porting some of our
developer docs to sphinx. In particular the quickstarts. Feedback
appreciated:

http://docs.geoserver.org/1.7.x/developer/quickstart/index.html
http://docs.geoserver.org/1.7.x/developer/maven-guide/index.html
http://docs.geoserver.org/1.7.x/developer/eclipse-guide/index.html

Basically what I did was instead of having two quickstarts, one for
maven one for eclipse, i just did one unified one. And then broke out
separate "guides" for doing stuff with maven and eclipse.

I figured the previous versions on the wiki were trying to do too much
by being both a step by step quickstart, and a reference of how to do
other stuff.

-Justin

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------------------------------------------------------
_______________________________________________
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.