kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
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.
67 lines
3.1 KiB
67 lines
3.1 KiB
3 years ago
|
---
|
||
|
|
sidebar_navigation:
|
||
|
|
title: Contribute to documentation
|
||
|
|
priority: 999
|
||
|
|
description: Overview of the OpenProject documentation
|
||
|
|
robots: index, follow
|
||
|
|
keywords: contribution, documentation, documentation process
|
||
|
|
---
|
||
|
|
|
||
|
|
# Contribute to the OpenProject documentation
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## What does the OpenProject documentation entail?
|
||
|
|
|
||
|
|
The OpenProject documentation makes available user guides, system admin, installation and operation, API as well as development guides and release notes.
|
||
|
|
|
||
|
|
Current and future users of the application find instructions for the set up and configuration of OpenProject in the documentation. Furthermore, it contains use cases and usage instructions for all OpenProject features and the use of OpenProject with other applications.
|
||
|
|
|
||
|
|
This documentation evolves continuously with new features and improvements to achieve clarity, accuracy, and completeness.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Where to find the OpenProject documentation?
|
||
|
|
|
||
|
|
The documentation for OpenProject is published on https://www.openproject.org/docs/. You can also access the documentation from your OpenProject application under user guides and API documentation below the question mark at the top right in the header menu.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Who can contribute to the documentation?
|
||
|
|
|
||
|
|
Being proudly open source, we invite anyone in our community to contribute to our software as well as the documentation to improve it even further.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## What can you contribute to the documentation?
|
||
|
|
|
||
|
|
Documentation improvements and changes apply to the documentation described in the section above. Documentation changes are **not** changes or additions to the code of the OpenProject application. For contributions to the code, see our [product development guide](../product-development-handbook/#openproject-product-development-handbook).
|
||
|
|
|
||
|
|
We are looking forward to receiving the following contributions from you:
|
||
|
|
|
||
|
|
- Eliminating errors and working on other improvements in the existing documentation. This could be missing content, e.g. descriptions or step-by-step guides for features.
|
||
|
|
|
||
|
|
- Adding use cases.
|
||
|
|
|
||
|
|
- Adding visuals, e.g. screenshots, to complement descriptions.
|
||
|
|
|
||
|
|
- Fixing of spelling, grammar, punctuation mistakes.
|
||
|
|
|
||
|
|
- Fixing of internal and external links that are not working or are incorrect.
|
||
|
|
|
||
|
|
- Translations into your mother tongue (coming soon).
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
| Topic | Content |
|
||
|
|
| ------------------------------------------------------ | :----------------------------------------------------------- |
|
||
|
|
| [Documentation process](documentation-process) | A step-by-step guide on how to contribute to the documentation. |
|
||
|
|
| [Documentation style guide](documentation-style-guide) | What are the styles and other requirements to follow when contributing to the documentation? |
|
||
|
|
| [Contribution support](contribution-support) | What to do if you need help regarding your contribution to the documentation? |
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
With this guide for contributing to the OpenProject documentation we followed and took inspiration from the [Contribute to GitLab guide](https://about.gitlab.com/community/contribute/).
|