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.
53382 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 7f9fba77cb
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7f9fba77cb'
${ noResults }
openproject/docs
History
Oliver Günther bbc557ad38
Merge branch 'documentation' into dev 		5 years ago
..
api Merge branch 'documentation' into dev 5 years ago
configuration Extend documentation with images 6 years ago
development Update report-a-bug.md 5 years ago
images/openid Add images 6 years ago
installation Update manual install with new node.js version 5 years ago
operations Merge branch 'release/10.0' into dev 5 years ago
plugins Removed "Supported plugins" that have been rolled into the main repo. 5 years ago
repositories Edit README.md (#7149) 6 years ago
security Add statement on security and add pgp key 6 years ago
user Update README.md 5 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 Fix other incorrect links 6 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, 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/.