OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/docs
Oliver Günther 6bb1cdba88
Split APIv3 documentation into stable/dev versions
6 years ago
..
api Split APIv3 documentation into stable/dev versions 6 years ago
configuration [28828] Implement regexp-based suffix lookup for mail addresses 6 years ago
development
installation Update README.md 6 years ago
operations
plugins
repositories Fix other incorrect links 6 years ago
user [28615] Change links to wiki text formatting 6 years ago
COPYING.rdoc
COPYRIGHT.rdoc
COPYRIGHT_short.rdoc
README.md Fix other incorrect links 6 years ago

README.md

OpenProject Community Guides

Installation

Get started with installing and upgrading OpenProject using our Installation Guide starting point.

The guides for manual, packaged and Docker-based installations are provided.

Upgrading

The detailed upgrade instructions for our packaged installer are located on the official website.

The guides for manual, packaged and Docker-based upgrading are provided.

Operation

User Guides

Please see our User Guide pages for detailed documentation on the functionality of OpenProject.

Development

APIv3 documentation sources

The documentation for APIv3 is written in the API Blueprint Format and its sources are being built from the entry point apiv3-documentation.apib.

You can use aglio to generate HTML documentation, e.g. using the following command:

aglio -i apiv3-documentation.apib -o api.html

The output of the API documentation at dev branch is continuously built and pushed to Github Pages at opf.github.io/apiv3-doc/.