Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an installation guide #20

Open
jkoshy opened this issue May 6, 2011 · 0 comments
Open

Create an installation guide #20

jkoshy opened this issue May 6, 2011 · 0 comments

Comments

@jkoshy
Copy link
Contributor

jkoshy commented May 6, 2011

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant