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.
54421 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: a37166607d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a37166607d'
${ noResults }
openproject/help
History
Oliver Günther 4c6b3f7c0f
Merge remote-tracking branch 'origin/release/10.3' into dev 		5 years ago
..
cloud-edition-guide Commit broken link changes 5 years ago
development Update copyright notice 5 years ago
enterprise-edition-guide Adding installation checklist to Enterprise Edition guide 5 years ago
getting-started Add product demo video 5 years ago
installation-and-operations Fix typo 5 years ago
release-notes Remove "Read more" sections of old release notes 5 years ago
system-admin-guide Commit project settings 5 years ago
unused-images Move help into separate folder per article 5 years ago
user-guide Merge remote-tracking branch 'origin/release/10.3' into dev 5 years ago
.gitkeep Add new help folder 5 years ago
README.md Adding installation checklist to Enterprise Edition guide 5 years ago
move_files.rb Move help into separate folder per article 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/.