Content structure for deegree webservices documentation
Building/contributing to the documentation
Documentation is located in the official deegree 3 GitHub repository. Work is done in the handbook branch (will be merged into master).
The repository contains a Maven module (deegree-services/deegree-webservices-handbook) that encapsulates the invocation of Sphinx, so if you have Sphinx and LaTeX installed, you can use "mvn package" to build HTML and PDF versions of the documentation. A recent version of Sphinx and LaTeX is required for building it.
The deegree build server automatically builds the handbook branch and publishes the handbook to the deegree homepage.
In order to learn about the markup used by Sphinx, consider this tutorial.
1. Completion status (2013-03-19)
Target date for a content-complete and reviewed version is 2013-03-19 (together with the release of deegree webservices 3.2).
Chapter |
Content status |
Assigned to |
Review by (correctness) |
Review by (readability) |
Current version |
1. Introduction |
complete |
Occam Labs |
|
IDgis |
|
2. Installation |
complete |
Occam Labs |
|
IDgis |
|
3. Getting started |
complete |
Occam Labs |
|
IDgis |
|
4. Configuration basics |
complete |
IDgis / Occam Labs |
|
IDgis |
|
5. Web services |
complete |
Occam Labs / lat/lon |
|
IDgis |
|
6. Feature stores |
complete |
Occam Labs |
|
IDgis |
|
7. Tile stores |
complete |
Occam Labs |
|
IDgis |
|
8. Coverage stores |
complete |
lat/lon |
|
|
|
9. Metadata stores |
90% |
lat/lon |
|
|
|
10. Map layers |
complete |
Occam Labs |
|
IDgis |
|
11. Map themes |
complete |
Occam Labs |
|
IDgis |
|
12. Map styles |
complete |
Occam Labs |
|
|
|
13. Server connections |
complete |
Occam Labs |
|
IDgis |
|
14. Process providers |
complete |
Occam Labs |
|
IDgis |
|
15. Coordinate reference systems |
complete |
Occam Labs |
|
|
|
16. REST interface |
complete |
Occam Labs |
|
IDgis |
|
17. Java modules and libraries |
complete |
Occam Labs |
|
IDgis |
2. Suggested How to's
The following additional How to's could be useful:
- How to access and serve raster data?
- How to access and serve vector data?
- How to access and serve metadata?
- How to access and serve INSPIRE datasets?
How to access and serve OpenStreetMap data?
- How to access data from a remote WMS and integrate into your WMS?
- How to setup INSPIRE compliant services?
- How to setup a Catalogue Service for the Web (CSW)?
- How to setup a Web Processing Service (WPS)?
- How to setup and edit metadata?
- How can I check the working of my Web services?
- How can I use my Web services in other applications?
- How to secure services?
- How to deal with problems?