[Users] Changed GeoExt website/docs update cycle

Andreas Hocevar ahocevar at opengeo.org
Mon Oct 11 10:45:13 CEST 2010


Hi,

On Oct 11, 2010, at 10:01 , Eric Lemoine wrote:

> On Sat, Oct 9, 2010 at 9:10 PM, Andreas Hocevar <ahocevar at opengeo.org> wrote:
>> Hi,
> 
> Hi Andreas, and thanks for working on that.
> 
>> as part of the preparations for the 1.0 release, I changed the way the GeoExt website is updated.
>> 
>> Until now, http://geoext.org/ pointed to the trunk version of the website,
> 
> To me the website doesn't have a trunk. And I don't see the need for
> branches for the website at this point.

What about http://svn.geoext.org/core/trunk/docsrc and e.g. http://svn.geoext.org/core/tags/release-1.0-rc1/docsrc ? These contains the whole website each.

> 
>> including the documentation, examples and API docs for trunk. This documentation has now moved to http://dev.geoext.org/docs/
> 
>> From now on, http://geoext.org/ points to the website version of the latest release (currently 1.0-rc1). A static copy of the docs will also be included in all upcoming release bundles, which means that version specific docs will be available under http://api.geoext.org/, e.g. http://api.geoext.org/1.0/docs/.
> 
> We could have http://docs.geoext.org/trunk,
> http://docs.geoext.org/1.0, etc. These pages will not point to the
> entire GeoExt web site, but just to the documentation pages (the
> equivalent of today's <http://geoext.org/docs.html>).

Our documentation is not just the API docs. We made some changes to our tutorials and primers in the process of preparing the release, and these changes were release specific.

> 
> I'm just suggesting to not duplicate the entire website, but just the
> documentation sites.
> 
> What do you think?

I think it does make sense to keep the whole website versioned. This is why we branch and tag core, which contains geoext (the library) and docsrc (the website). Again, there is not only the api docs, but also tutorials and more, which can change over time, dependent on the GeoExt release. If you step back for a moment and try to look at the website as our documentation, with the API docs being just a part of it, you'll hopefully see that this makes sense. This is the same approach that GeoServer takes.

Also, the new docs subfolder included in upcoming release zip bundles, will contain the whole web site as well.

Regards,
Andreas.



More information about the Users mailing list