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.
57826 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 7c5b5e2a2f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7c5b5e2a2f'
${ noResults }
openproject/docs
History
ulferts 14ccf0b689
Merge branch 'release/11.0' into dev 		4 years ago
..
api rephrasing 4 years ago
cloud-edition-guide grammar [ci skip] 4 years ago
development elaborate on permission checking in backend 4 years ago
enterprise-edition-guide Added EE trial in FAQ 5 years ago
getting-started port documentation added to dev over to release branch 4 years ago
installation-and-operations Improve mysql migration documentation 4 years ago
release-notes Set release date to 12th October 4 years ago
system-admin-guide update permission requirements in docs 4 years ago
unused-images Move help into docs 5 years ago
user-guide small changes to fix a displaying error 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 Add new copyright for the short version, too. 5 years ago
README.md Move help into docs 5 years ago

README.md

sidebar_navigation description robots keywords
[{title OpenProject Documentation} {priority 999}] Help and documentation for OpenProject Community, Enterprise Edition and Cloud Edition. 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/.