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.
59961 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: f388e941a9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f388e941a9'
${ noResults }
openproject/docs
History
ulferts 23a8bef352
Merge pull request #9629 from opf/fix/copyright-file 		3 years ago
..
api remove no_self_notified user preference 3 years ago
development Move license and copyright docs to root, fix names and references 3 years ago
enterprise-guide Pricing changes new screenshots (#9628) 3 years ago
faq Move license and copyright docs to root, fix names and references 3 years ago
getting-started Screenshots renaming chronological order (#9588) 3 years ago
installation-and-operations Update oidc settings 3 years ago
release-notes Update README.md 3 years ago
system-admin-guide info on how to run console in docker setups 3 years ago
unused-images Move help into docs 5 years ago
user-guide Merge remote-tracking branch 'origin/release/11.4' into dev 3 years ago
README.md fix(docs): stop using https://docs.openproject.org; fix redirected links (#9400) 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 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/.