Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#59512] Create new section (Contribution guide) how to "give back", … #17312

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/contributions-guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_navigation:
title: Contributions guide
priority: 956
description: OpenProject contributions guide.
keywords: contributions guide, translate OpenProject, contribute, community, documentation
---

# Contributions guide

Welcome to the OpenProject **Contributions guide**.

This platform thrives on the support of its community, and there are many ways you can help make it even better. Whether you're a developer, a user, or simply someone passionate about improving open-source tools, your contributions matter.

## Overview

| Topic | Content |
|-----------------------------------------------------------|:----------------------------------------------------------|
| [Contribute to documentation](contribution-documentation) | Learn how you can contribute to OpenProject documentation |
| [Translate OpenProject](translate-openproject) | Help translate OpenProject |
| [Give back to community](give-back-to-community) | Learn how you can support OpenProject community |


## How can you help?

**Contribute to Documentation**
Help keep our documentation accurate, comprehensive, and user-friendly. Whether it's fixing typos, updating outdated information, or adding new sections, your contributions make a difference. [Learn more](./contribution-documentation/).

**Translate OpenProject**
Assist in making OpenProject accessible in more languages or refine existing translations. Your input ensures that users worldwide have a seamless experience. [Learn more](./translate-openproject/).

**Support the Community**
Share your experiences by leaving a review, sharing our blog articles, or promoting OpenProject in your network. Every small effort helps expand our community. [Learn more](./give-back-to-community).

Please also refer to the [Development guide](../development) for Code review guidelines.
62 changes: 62 additions & 0 deletions docs/contributions-guide/contribution-documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
sidebar_navigation:
title: Contribute to documentation
priority: 999
description: Overview of the OpenProject documentation
keywords: contribution, documentation, documentation process
---

# Contribute to the OpenProject documentation

High-quality documentation is essential for the success of OpenProject. It ensures that users, developers, and administrators can effectively understand and use the platform.

By contributing to the documentation, you help:

- Keep the content accurate and up-to-date.
- Make complex features easier to understand.
- Ensure that OpenProject is accessible to a wider audience.

Whether it’s fixing typos, clarifying instructions, or adding missing sections, every contribution is valuable. This guide will walk you through the process of contributing to our documentation, ensuring your work is effective and aligned with OpenProject’s standards.

## 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/).

> [!TIP]
> Documentation changes are **not** changes or additions to the code of the OpenProject application. For contributions to the code, see our [product development guide](../../development/product-development-handbook/). Please also refer to the [development guide](../../development/code-review-guidelines/) for Code review guidelines

## OpenProject documentation overview

The OpenProject documentation provides comprehensive resources, including user guides, system administration, installation and operation instructions, API references, development guides, and release notes. It is available online at [OpenProject Documentation](https://www.openproject.org/docs/), and can also be accessed directly from your OpenProject application via the **Help** menu (question mark icon in the top-right corner).

The documentation supports current and future users by offering step-by-step instructions for setup, configuration, and integration of OpenProject. It also provides detailed use cases, feature guides, and instructions for using OpenProject alongside other applications.

To ensure clarity, accuracy, and completeness, the documentation is continuously updated to reflect new features, improvements, and community feedback.

### Contributing to OpenProject Documentation

As an open-source platform, OpenProject thrives on community collaboration. Contributions to our documentation are open to everyone, whether you're a developer, a long-time user, or someone new to the platform.

By contributing to the documentation, you help ensure it remains accurate, clear, and up-to-date, benefiting the entire OpenProject community. We welcome contributions of all kinds, including improving existing content, fixing errors, and adding new sections.

## Contribution guidelines for documentation

### Report it via e-mail

If you would like to report a typo or an inconsistency in our documentation, the quickest way to do it is to **write an e-mail** to [[email protected]](mailto:[email protected]) and describe it with as much detail an possible.

### Let us know through the OpenProject Community installation

You can also join us directly through the [OpenProject Community installation](https://community.openproject.org). Here you can **leave a message on the [Forum](https://community.openproject.org/projects/openproject/forums)**, or **create a work package with the type *Documentation* ** and describe or request a documentation change.

To gain access to the community installation at, please send an email to [[email protected]](mailto:[email protected]) with the subject line **"Joining Community"**. Our team will review your request and send you an invitation as soon as possible.

### Write your own pull request

If you prefer, you can also go ahead and create a **draft pull request** with your suggestions and ask for the review from our team. Please take a look at the [documentation process](./documentation-process/) for the exact steps to do that and consult the [documentation style guide](./documentation-style-guide/) for instructions on documentation formatting in OpenProject.
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ This guide describes how internal team members with write permissions can contri

## Prerequisites

1. [The contributor has a user account on GitHub.com](../../../development/contribution-documentation/documentation-process/#step-1-create-user-account-on-githubcom)
1. [The contributor has a user account on GitHub.com](../documentation-process/#step-1-create-user-account-on-githubcom)
2. The contributor has write permissions on the [OpenProject repository](https://github.com/opf/openproject)
3. [Software Typora editor installed](../../../development/contribution-documentation/documentation-process/#step-2-install-typora)
4. [Software GitHub Desktop installed](../../../development/contribution-documentation/documentation-process/#step-3-install-github-desktop)
3. [Software Typora editor installed](../documentation-process/#step-2-install-typora)
4. [Software GitHub Desktop installed](../documentation-process/#step-3-install-github-desktop)

## Step 1: Clone the OpenProject repository in GitHub Desktop

Expand Down
70 changes: 70 additions & 0 deletions docs/contributions-guide/give-back-to-community/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
sidebar_navigation:
title: Give back to community
priority: 700
description: Guide on how to contribute to OpenProject community
keywords: community, review, video, blog, contribution
---

# Give back to community

OpenProject thrives on the strength and engagement of its community. Beyond coding or documentation, there are many ways you can help spread the word, share your experiences, and inspire others to adopt and use OpenProject effectively.

## Share your experience

> [!IMPORTANT] By submitting your content, we assume that you grant us permission to publish it on our platforms. If you would like to review the content before it is published, please let us know explicitly, and we will be happy to accommodate your request.

Your unique experience with OpenProject can inspire others and provide valuable feedback to our team. Here are some ideas for sharing your story:

- **Written Texts**
Create a brief article (0.5–2 pages) that covers the following topics:

- A short introduction of yourself and your project.
- Basic details such as the project’s duration, objectives, and participants.
- An overview of which OpenProject modules you used and how they supported your work.
- Your overall experience: What works well for you? What could be improved?
- Include screenshots showcasing your OpenProject setup (with permission to publish).

**Example**: take a look one one our case studies with an [NGO](https://www.openproject.org/project-management-ngos-foundations/case-study-open-source-initiative-osi/) , a [university project](https://www.openproject.org/project-management-universities-research/case-study-rewrite/) or a [municipality](https://www.openproject.org/project-management-public-sector/case-study-city-ravensburg/).

- **Blog Posts**
Write a detailed blog post about your OpenProject journey. You can either:

- Submit your blog post for publication on the OpenProject website. [Contact us](https://www.openproject.org/contact/) for guidelines.
- Publish it on your own channels (website, blog, or LinkedIn) and link back to OpenProject.

- **Video Contributions**
Record a short video explaining how you or your team use OpenProject. Include key features, workflows, and tips that others might find useful.

- **Testimonials and Quotes**
Share a short testimonial or quote about your experience with OpenProject. If possible, **include a professional photo** of yourself or your team for publication.

## Support us online

Help OpenProject reach more users by engaging with our content and sharing it with your network.

- **Social Media Posts**
- Share your experience with OpenProject on your social channels, including a link to our website.
- You can also re-share content from the [OpenProject blog](https://www.openproject.org/blog/) or our official social media accounts.

[Follow us on LinkedIn](https://www.linkedin.com/company/openproject-gmbh)

[Follow us on Reddit](https://www.reddit.com/r/openproject)

[Follow us on Fosstodon](https://fosstodon.org/@openproject)

[Follow us on Twitter/X](https://twitter.com/openproject)

[Follow us on Bluesky](https://bsky.app/profile/openproject.bsky.social)
- **Add a Backlink to Your Website**
Include a link to OpenProject’s website on your blog, portfolio, or company website to help more people discover our tool.
- **Write a Review**
Share your thoughts about OpenProject on one of our review platforms. [Leave a review ](https://www.openproject.org/reviews/).

## Spread the word

Let your network know how OpenProject has made an impact for you. Whether it’s during a team meeting, at an industry event, or simply in a conversation with a peer, sharing your experiences can inspire others to explore OpenProject.

## Join our community

Be part of the conversation! **Join us in our weekly team call** and share how you use OpenProject in your team or organization.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_navigation:
title: Translate OpenProject
priority: 985
priority: 800
description: How to translate OpenProject to your language
keywords: translation, translate, crowdin, localization
---
Expand Down Expand Up @@ -64,4 +64,4 @@ If you are interested in becoming a proof reader, please contact one of the proj

If your language is not listed in the list of CrowdIn languages, please contact our project managers or send us an email so we can add your language.

Find out more about our development concepts regarding translations [here](../concepts/translations).
Find out more about our development concepts regarding translations [here](../../development/concepts/translations).
57 changes: 0 additions & 57 deletions docs/development/contribution-documentation/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/faq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ OpenProject changed the database from MySQL (rarely also MariaDB) in older Versi

### How can I contribute to OpenProject?

We welcome everybody willing to help make OpenProject better. There are a lot of possibilities for helping, be it [improving the translations](../development/translate-openproject) via crowdin, answering questions in the [forums](https://community.openproject.org/projects/openproject/forums) or by fixing bugs and implementing features.
We welcome everybody willing to help make OpenProject better. There are a lot of possibilities for helping, be it [improving the translations](../contributions-guide/translate-openproject) via crowdin, answering questions in the [forums](https://community.openproject.org/projects/openproject/forums) or by fixing bugs and implementing features.

If you want to code, a good starting point would be to make yourself familiar with the [basic approaches for developing](../development/) in OpenProject and opening a pull request on GitHub referencing an existing bug report or feature request. Find our GitHub page [here](https://github.com/opf/openproject).

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/12/12-0-7/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ There is now a separate setting for the max API size that will be used for these

OpenProject relies on community translations for some languages that we cannot provide translations for ourselves. It was brought to our attention that the Russian translations partially contain expletive languages. Thanks to community contributors Sergey and Christina, these translations were fixed on crowdin and could now be included into the release.

We need your help to improve and extend translations of OpenProject into your native language. To get more information, please see our [Translating OpenProject guide](../../../development/translate-openproject/) and our [project on crowdin.com](https://crowdin.com/project/openproject), where you can provide and help approve translations from your browser. If you wish to become a proofreader for your language, please reach out to [[email protected]](mailto:[email protected])
We need your help to improve and extend translations of OpenProject into your native language. To get more information, please see our [Translating OpenProject guide](../../../contributions-guide/translate-openproject/) and our [project on crowdin.com](https://crowdin.com/project/openproject), where you can provide and help approve translations from your browser. If you wish to become a proofreader for your language, please reach out to [[email protected]](mailto:[email protected])

## Custom plugins in packaged installations

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/13-4-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,4 +173,4 @@ An important part is also the translations, for which we thank the following con
- [Marek Bajon](https://crowdin.com/profile/mbajon), who translated to Polish
- [Vlastislav Dockal](https://crowdin.com/profile/vdockal), who translated to Czech

Would you like to help out with translations yourself? Then take a look at our [translation guide](../../development/translate-openproject/) and find out exactly how you can contribute. It is very much appreciated!
Would you like to help out with translations yourself? Then take a look at our [translation guide](../../contributions-guide/translate-openproject/) and find out exactly how you can contribute. It is very much appreciated!
Loading