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.
33651 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: a9ed4ca12a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a9ed4ca12a'
${ noResults }
openproject/docs
History
Oliver Günther 6ef4211e77
Bump copyright to 2018 (#6171) 		7 years ago
..
api document custom actions 7 years ago
configuration LDAP Single Sign-on (#5888) 7 years ago
development Update ruby version in docs for setting up dev environment (#6011) 7 years ago
installation Add apt-transport-https to ubuntu guides 7 years ago
operations Merge branch 'release/7.4' into dev 7 years ago
plugins update 8 years ago
repositories Rename doc to docs and restructure operations folder 8 years ago
COPYING.rdoc Rename doc to docs and restructure operations folder 8 years ago
COPYRIGHT.rdoc Bump copyright to 2018 (#6171) 7 years ago
COPYRIGHT_short.rdoc Bump copyright to 2018 (#6171) 7 years ago
README.md Rename doc to docs and restructure operations folder 8 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 and Docker-based installations are located here.

Upgrading

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

The guides for manual and Docker-based installations are located here.

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