Prompted by http://projects.opengeo.org/CAPRA/ticket/705, I just wanted to say that I think deployment configuration information belongs in the Sphinx docs rather than the README. The README should stick to the information needed to get a developer up and running with the paver stuff, "production" deployment info goes in the manual. Obviously we don't have any strict rules about this sort of thing yet, but I think we should try to keep the README as short as possible and leave the detailed stuff for the manual. -- David Winslow OpenGeo - http://opengeo.org/
David, I followed the ticket description to the letter and did not remember about Sphinx docs. I will move the information I added to the README to the deployment.rst file here: http://github.com/GeoNode/geonode/blob/master/docs/source/deployment.rst Ariel
I'm not trying to point fingers or anything here. If you guys think keeping the deployment instructions in the README is a good idea I could probably be convinced. However, it seems like a easy place to draw the line. -- David Winslow OpenGeo - http://opengeo.org/ On Wed, Aug 18, 2010 at 1:06 PM, Ariel Nunez <ingenieroariel@gmail.com>wrote: > David, > > I followed the ticket description to the letter and did not remember > about Sphinx docs. > > I will move the information I added to the README to the > deployment.rst file here: > http://github.com/GeoNode/geonode/blob/master/docs/source/deployment.rst > > Ariel >
On Wed, Aug 18, 2010 at 12:36 PM, David Winslow <dwinslow@opengeo.org> wrote: > I'm not trying to point fingers or anything here. If you guys think keeping > the deployment instructions in the README is a good idea I could probably be > convinced. However, it seems like a easy place to draw the line. No problem, I think when Sebastian mentioned the README he implicitly meant "the docs". I agree with keeping the deployment info in the Sphinx docs, it's more organized that way. Ariel.
Yeah. My bad on saying README. +1 on this docs setup On Wed, Aug 18, 2010 at 1:49 PM, Ariel Nunez <ingenieroariel@gmail.com>wrote: > On Wed, Aug 18, 2010 at 12:36 PM, David Winslow <dwinslow@opengeo.org> > wrote: > > I'm not trying to point fingers or anything here. If you guys think > keeping > > the deployment instructions in the README is a good idea I could probably > be > > convinced. However, it seems like a easy place to draw the line. > > No problem, I think when Sebastian mentioned the README he implicitly > meant "the docs". > > I agree with keeping the deployment info in the Sphinx docs, it's more > organized that way. > > Ariel. > -- Sebastian Benthall OpenGeo - http://opengeo.org