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.
61027 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 3de0b33fa7
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3de0b33fa7'
${ noResults }
openproject/docs
History
Oliver Günther 3de0b33fa7
Update README.md 		3 years ago
..
api Task/40080 reduce excessive image file sizes in docs [skip ci] (#9887) 3 years ago
development Bump ruby to 2.7.5 3 years ago
enterprise-guide Update GDPR section on docs (#9921) 3 years ago
faq Correct prices for members [skip ci] 3 years ago
getting-started Bug/40081 find and fix broken anchors in docs [skip ci] (#9897) 3 years ago
installation-and-operations Update README.md 3 years ago
release-notes Added an additional bug fix and contribution 3 years ago
system-admin-guide Update README.md 3 years ago
unused-images Move help into docs 5 years ago
user-guide Bug/40081 find and fix broken anchors in docs [skip ci] (#9897) 3 years ago
README.md Fix some broken links in docs/ 3 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 [www.openproject.org/docs/](https://www.openproject.org/docs/).

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