Background

Welcome! From all of the GeoServer users and developers, we are happy to see that you have an interest in contributing to the GeoServer documentation. Whether it’s the fix of a typo or a whole new collection of pages, all contributions are appreciated. With your help we can make GeoServer documentation helpful and robust, and thus make GeoServer a better product.

Writing Documentation

GeoServer documentation written in reStructuredText, a lightweight markup syntax, and built into HTML and PDF content using Sphinx, a documentation framework written by the developers of Python. In this way, the documentation could be merged with the source code of GeoServer itself, and exist in the same repository. With this merge, version control follows naturally, so documentation can now be version specific. Since the repository requires authentication to make changes, authors must be granted access before being able to directly contribute to the documentation. While this does slightly raise the barrier to entry, the ability to control the quality of the documentation was seen as a greater benefit.

Note

Prior to the use of Sphinx GeoServer documentation was created using a wiki as part of the GeoServer home page. While this allowed anyone to sign up and contribute documentation we ended up with problems of vandalism and lacked features we now enjoy (Version control, PDF export).

Read on to find out Contributing.

Previous: Home
Next: Quickfix