Markus Kahl
5c1718ec5e
news_item.yml as seen above is an exception because the word 'news' is not countable. Hence the _item form instead of just singular.
sidebar_navigation, description, robots, keywords
| sidebar_navigation | description | robots | keywords | ||||
|---|---|---|---|---|---|---|---|
|
Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud. | index, follow | help, documentation |
OpenProject Documentation
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
- Backup guides for manual, packaged and Docker-based installations
- Alter configuration of OpenProject
- Manual repository integration for Git and Subversion
- Configure incoming mails
- Install custom plugins
User Guides
Please see our User Guide pages for detailed documentation on the functionality of OpenProject.
Development
- Quick Start for developers
- Full development environment for developers on Ubuntu and Mac OS X
- Developing plugins
- Developing OmniAuth Plugins
- Running tests
- Code review guidelines
- API documentation
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/.