Create an installation guide #20
Description
Create user-centric documentation covering the care and feeding of the API Server.
A rough outline of this article would be:
- Introduction
- A brief overview of the OSM project.
- A description of what this API service does.
- Limitations of this API service.
- Pre-requisites for installation.
- Supported operating systems.
- Pre-requisite packages.
- The installation process.
- Describe this for each supported OS.
- Monitoring the operation of the server.
- Facilities for logging.
- Monitoring performance metrics.
- Looking out for errors.
- Troubleshooting help.
- Appendices:
- How to report bugs.
- Building the server from source.
- Contributing source code patches.
The guide would need be written in using open-source documentation tools that are in common use in the open-source eco-system, say one of LaTeX, ConTeXt or DocBook.