mirror of
https://github.com/opf/openproject.git
synced 2026-06-14 03:30:14 +00:00
Andrej Sandorf
a0701032b6
* fix(docs): remove unused images * fix(docs): reduce png image sizes * fix(docs): invalid signs in markdown formatting * fix(docs): adjust legal link * fix(docs): don't use ZWSP & NBSP without reason * fix(docs): cleanup release notes index page * fix(docs): remove unused markdown frontmatter
2.5 KiB
2.5 KiB
sidebar_navigation, description, keywords
| sidebar_navigation | description | keywords | ||||
|---|---|---|---|---|---|---|
|
Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud. | help, documentation |
OpenProject Documentation
**Note**: To better read our OpenProject Documentation, please go to [www.openproject.org/docs/](https://www.openproject.org/docs/).
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 upgrading are provided.
Operation
- Backing up you installation
- 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.
Use Cases
Please see our Use Cases section for detailed how-to guides and step-by-step instruction on how to set up a variety of common cases and views.
Development
- 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 OpenAPI Format and its sources are being built from the entry point openapi-spec.yml.