TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
58670 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: b2b307c4e2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b2b307c4e2'
${ noResults }
openproject/docs
History
Markus Kahl b2b307c4e2
MySQL migration docs update 		4 years ago
..
api extend API documentation for principals (#9023) 4 years ago
cloud-edition-guide Documentation for features introduced with 11.2 (and a few other additions) (#9073) 4 years ago
development document memory requirements of running docker (#9139) 4 years ago
enterprise-edition-guide update link to installation checklist and update wording 4 years ago
getting-started Updated getting started video 4 years ago
installation-and-operations MySQL migration docs update 4 years ago
release-notes Add release-notes file 4 years ago
system-admin-guide OAuth additions in docs (scope was missing) (#9094) 4 years ago
unused-images Move help into docs 5 years ago
user-guide add info about behavior of versions in other projects 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/.