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.
50511 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 44f5fb1496
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '44f5fb1496'
${ noResults }
openproject/docs
History
Oliver Günther 506760c96a
Add docker incoming-mails guide 		6 years ago
..
api Add hidden flag for project-context queries 6 years ago
configuration Add docker incoming-mails guide 6 years ago
development bump ruby to 2.6.1 6 years ago
installation Add information of minimal MariaDB (10.2) version necessary for utf8mb4 support. 6 years ago
operations Add postgresql migration guide 6 years ago
plugins update 8 years ago
repositories Fix other incorrect links 6 years ago
user [28615] Change links to wiki text formatting 6 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/.