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
Wieland Lindenthal ffa5ac84a8
Allow deletion of placeholder users when permission of :manage_placeholder_user give (#9018)
4 years ago
..
api Allow deletion of placeholder users when permission of :manage_placeholder_user give (#9018) 4 years ago
cloud-edition-guide Fix typos in user facing and non-user facing code 4 years ago
development Merge branch 'release/11.1' into dev 4 years ago
enterprise-edition-guide Merge branch 'release/11.1' into dev 4 years ago
getting-started Documentation: spelling, smart characters, invalid links fixed (#8940) 4 years ago
installation-and-operations Merge remote-tracking branch 'origin/release/11.1' into dev 4 years ago
release-notes Add README 4 years ago
system-admin-guide small additions to manage users documentation 4 years ago
unused-images Move help into docs 5 years ago
user-guide Move chapter about rates for labor costs (in docs) 4 years ago
COPYING.rdoc Rename doc to docs and restructure operations folder 8 years ago
COPYRIGHT.rdoc Update Copyright 5 years ago
COPYRIGHT_short.rdoc update copyright to 2021 (#8925) 4 years ago
README.md Documentation for 11.1.0 rebased (#8897) 4 years ago

README.md

sidebar_navigation description robots keywords
[{title OpenProject Documentation} {priority 999}] Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud. index, follow help, documentation

OpenProject Documentation

**Note**: To better read our OpenProject Documentation, please go to [docs.openproject.org](https://docs.openproject.org).

ToDo: check all links.

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/.