diff --git a/docs/contributions-guide/README.md b/docs/contributions-guide/README.md new file mode 100644 index 000000000000..84e9211703c6 --- /dev/null +++ b/docs/contributions-guide/README.md @@ -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. diff --git a/docs/contributions-guide/contribution-documentation/README.md b/docs/contributions-guide/contribution-documentation/README.md new file mode 100644 index 000000000000..1634ac40fe99 --- /dev/null +++ b/docs/contributions-guide/contribution-documentation/README.md @@ -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 [support@openproject.com](mailto:support@openproject.com) 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 [support@openproject.com](mailto:support@openproject.com) 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. diff --git a/docs/development/contribution-documentation/contribution-support/README.md b/docs/contributions-guide/contribution-documentation/contribution-support/README.md similarity index 100% rename from docs/development/contribution-documentation/contribution-support/README.md rename to docs/contributions-guide/contribution-documentation/contribution-support/README.md diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/README.md b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/README.md similarity index 91% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/README.md rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/README.md index f3d2f091716c..66a91125bc08 100644 --- a/docs/development/contribution-documentation/documentation-process-internal-contributor/README.md +++ b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/README.md @@ -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 diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/add-documentation-label-pull-requests.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/add-documentation-label-pull-requests.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/add-documentation-label-pull-requests.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/add-documentation-label-pull-requests.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/clone-repository.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/clone-repository.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/clone-repository.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/clone-repository.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/commit-history-in-github-desktop.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/commit-history-in-github-desktop.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/commit-history-in-github-desktop.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/commit-history-in-github-desktop.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/comparing-changes.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/comparing-changes.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/comparing-changes.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/comparing-changes.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-1.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-1.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-1.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-1.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-2.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-2.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-2.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-2.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/create-pull-request-github-desktop.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/create-pull-request-github-desktop.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/create-pull-request-github-desktop.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/create-pull-request-github-desktop.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/fetch-origin-in-github-desktop.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/fetch-origin-in-github-desktop.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/fetch-origin-in-github-desktop.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/fetch-origin-in-github-desktop.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/push-origin-in-github-desktop.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/push-origin-in-github-desktop.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/push-origin-in-github-desktop.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/push-origin-in-github-desktop.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/select-cloned-repository.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/select-cloned-repository.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/select-cloned-repository.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/select-cloned-repository.png diff --git a/docs/development/contribution-documentation/documentation-process-internal-contributor/select-reviewer-for-documentation.png b/docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/select-reviewer-for-documentation.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process-internal-contributor/select-reviewer-for-documentation.png rename to docs/contributions-guide/contribution-documentation/documentation-process-internal-contributor/select-reviewer-for-documentation.png diff --git a/docs/development/contribution-documentation/documentation-process/Create-draft-pull-request.png b/docs/contributions-guide/contribution-documentation/documentation-process/Create-draft-pull-request.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/Create-draft-pull-request.png rename to docs/contributions-guide/contribution-documentation/documentation-process/Create-draft-pull-request.png diff --git a/docs/development/contribution-documentation/documentation-process/README.md b/docs/contributions-guide/contribution-documentation/documentation-process/README.md similarity index 100% rename from docs/development/contribution-documentation/documentation-process/README.md rename to docs/contributions-guide/contribution-documentation/documentation-process/README.md diff --git a/docs/development/contribution-documentation/documentation-process/Ready-for-review.png b/docs/contributions-guide/contribution-documentation/documentation-process/Ready-for-review.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/Ready-for-review.png rename to docs/contributions-guide/contribution-documentation/documentation-process/Ready-for-review.png diff --git a/docs/development/contribution-documentation/documentation-process/add-documentation-label-pull-requests.png b/docs/contributions-guide/contribution-documentation/documentation-process/add-documentation-label-pull-requests.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/add-documentation-label-pull-requests.png rename to docs/contributions-guide/contribution-documentation/documentation-process/add-documentation-label-pull-requests.png diff --git a/docs/development/contribution-documentation/documentation-process/branches-drop-down-list.png b/docs/contributions-guide/contribution-documentation/documentation-process/branches-drop-down-list.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/branches-drop-down-list.png rename to docs/contributions-guide/contribution-documentation/documentation-process/branches-drop-down-list.png diff --git a/docs/development/contribution-documentation/documentation-process/clone-repository.png b/docs/contributions-guide/contribution-documentation/documentation-process/clone-repository.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/clone-repository.png rename to docs/contributions-guide/contribution-documentation/documentation-process/clone-repository.png diff --git a/docs/development/contribution-documentation/documentation-process/commit-history-in-github-desktop.png b/docs/contributions-guide/contribution-documentation/documentation-process/commit-history-in-github-desktop.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/commit-history-in-github-desktop.png rename to docs/contributions-guide/contribution-documentation/documentation-process/commit-history-in-github-desktop.png diff --git a/docs/development/contribution-documentation/documentation-process/continue-sign-in-in-browser.png b/docs/contributions-guide/contribution-documentation/documentation-process/continue-sign-in-in-browser.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/continue-sign-in-in-browser.png rename to docs/contributions-guide/contribution-documentation/documentation-process/continue-sign-in-in-browser.png diff --git a/docs/development/contribution-documentation/documentation-process/create-new-branch-step-1.png b/docs/contributions-guide/contribution-documentation/documentation-process/create-new-branch-step-1.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/create-new-branch-step-1.png rename to docs/contributions-guide/contribution-documentation/documentation-process/create-new-branch-step-1.png diff --git a/docs/development/contribution-documentation/documentation-process/create-new-branch-step-2.png b/docs/contributions-guide/contribution-documentation/documentation-process/create-new-branch-step-2.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/create-new-branch-step-2.png rename to docs/contributions-guide/contribution-documentation/documentation-process/create-new-branch-step-2.png diff --git a/docs/development/contribution-documentation/documentation-process/create-new-branch-step-3.png b/docs/contributions-guide/contribution-documentation/documentation-process/create-new-branch-step-3.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/create-new-branch-step-3.png rename to docs/contributions-guide/contribution-documentation/documentation-process/create-new-branch-step-3.png diff --git a/docs/development/contribution-documentation/documentation-process/create-pull-request-github-desktop.png b/docs/contributions-guide/contribution-documentation/documentation-process/create-pull-request-github-desktop.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/create-pull-request-github-desktop.png rename to docs/contributions-guide/contribution-documentation/documentation-process/create-pull-request-github-desktop.png diff --git a/docs/development/contribution-documentation/documentation-process/define-how-to-use-the-fork.png b/docs/contributions-guide/contribution-documentation/documentation-process/define-how-to-use-the-fork.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/define-how-to-use-the-fork.png rename to docs/contributions-guide/contribution-documentation/documentation-process/define-how-to-use-the-fork.png diff --git a/docs/development/contribution-documentation/documentation-process/disable-github-actions.png b/docs/contributions-guide/contribution-documentation/documentation-process/disable-github-actions.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/disable-github-actions.png rename to docs/contributions-guide/contribution-documentation/documentation-process/disable-github-actions.png diff --git a/docs/development/contribution-documentation/documentation-process/edit-the-pull-request.png b/docs/contributions-guide/contribution-documentation/documentation-process/edit-the-pull-request.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/edit-the-pull-request.png rename to docs/contributions-guide/contribution-documentation/documentation-process/edit-the-pull-request.png diff --git a/docs/development/contribution-documentation/documentation-process/fork-openproject.png b/docs/contributions-guide/contribution-documentation/documentation-process/fork-openproject.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/fork-openproject.png rename to docs/contributions-guide/contribution-documentation/documentation-process/fork-openproject.png diff --git a/docs/development/contribution-documentation/documentation-process/open-pr-in-forked-repository.png b/docs/contributions-guide/contribution-documentation/documentation-process/open-pr-in-forked-repository.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/open-pr-in-forked-repository.png rename to docs/contributions-guide/contribution-documentation/documentation-process/open-pr-in-forked-repository.png diff --git a/docs/development/contribution-documentation/documentation-process/pull-upstream-changes.png b/docs/contributions-guide/contribution-documentation/documentation-process/pull-upstream-changes.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/pull-upstream-changes.png rename to docs/contributions-guide/contribution-documentation/documentation-process/pull-upstream-changes.png diff --git a/docs/development/contribution-documentation/documentation-process/push-origin-in-github-desktop.png b/docs/contributions-guide/contribution-documentation/documentation-process/push-origin-in-github-desktop.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/push-origin-in-github-desktop.png rename to docs/contributions-guide/contribution-documentation/documentation-process/push-origin-in-github-desktop.png diff --git a/docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-1.png b/docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-1.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-1.png rename to docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-1.png diff --git a/docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-2.png b/docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-2.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-2.png rename to docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-2.png diff --git a/docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-3.png b/docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-3.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-3.png rename to docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-3.png diff --git a/docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-4.png b/docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-4.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/rebase-your-fork-step-4.png rename to docs/contributions-guide/contribution-documentation/documentation-process/rebase-your-fork-step-4.png diff --git a/docs/development/contribution-documentation/documentation-process/select-repository-to-be-cloned.png b/docs/contributions-guide/contribution-documentation/documentation-process/select-repository-to-be-cloned.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/select-repository-to-be-cloned.png rename to docs/contributions-guide/contribution-documentation/documentation-process/select-repository-to-be-cloned.png diff --git a/docs/development/contribution-documentation/documentation-process/select-reviewer-for-documentation.png b/docs/contributions-guide/contribution-documentation/documentation-process/select-reviewer-for-documentation.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/select-reviewer-for-documentation.png rename to docs/contributions-guide/contribution-documentation/documentation-process/select-reviewer-for-documentation.png diff --git a/docs/development/contribution-documentation/documentation-process/select-the-new-release-branch.png b/docs/contributions-guide/contribution-documentation/documentation-process/select-the-new-release-branch.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/select-the-new-release-branch.png rename to docs/contributions-guide/contribution-documentation/documentation-process/select-the-new-release-branch.png diff --git a/docs/development/contribution-documentation/documentation-process/sign-in-into-github.png b/docs/contributions-guide/contribution-documentation/documentation-process/sign-in-into-github.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/sign-in-into-github.png rename to docs/contributions-guide/contribution-documentation/documentation-process/sign-in-into-github.png diff --git a/docs/development/contribution-documentation/documentation-process/switch-the-default-branch-step-1.png b/docs/contributions-guide/contribution-documentation/documentation-process/switch-the-default-branch-step-1.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/switch-the-default-branch-step-1.png rename to docs/contributions-guide/contribution-documentation/documentation-process/switch-the-default-branch-step-1.png diff --git a/docs/development/contribution-documentation/documentation-process/switch-the-default-branch-step-2.png b/docs/contributions-guide/contribution-documentation/documentation-process/switch-the-default-branch-step-2.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/switch-the-default-branch-step-2.png rename to docs/contributions-guide/contribution-documentation/documentation-process/switch-the-default-branch-step-2.png diff --git a/docs/development/contribution-documentation/documentation-process/sync-fork-update-branch.png b/docs/contributions-guide/contribution-documentation/documentation-process/sync-fork-update-branch.png similarity index 100% rename from docs/development/contribution-documentation/documentation-process/sync-fork-update-branch.png rename to docs/contributions-guide/contribution-documentation/documentation-process/sync-fork-update-branch.png diff --git a/docs/development/contribution-documentation/documentation-style-guide/OpenProject_documentation_menu.png b/docs/contributions-guide/contribution-documentation/documentation-style-guide/OpenProject_documentation_menu.png similarity index 100% rename from docs/development/contribution-documentation/documentation-style-guide/OpenProject_documentation_menu.png rename to docs/contributions-guide/contribution-documentation/documentation-style-guide/OpenProject_documentation_menu.png diff --git a/docs/development/contribution-documentation/documentation-style-guide/README.md b/docs/contributions-guide/contribution-documentation/documentation-style-guide/README.md similarity index 100% rename from docs/development/contribution-documentation/documentation-style-guide/README.md rename to docs/contributions-guide/contribution-documentation/documentation-style-guide/README.md diff --git a/docs/development/contribution-documentation/documentation-style-guide/screenshot_area_highlight.png b/docs/contributions-guide/contribution-documentation/documentation-style-guide/screenshot_area_highlight.png similarity index 100% rename from docs/development/contribution-documentation/documentation-style-guide/screenshot_area_highlight.png rename to docs/contributions-guide/contribution-documentation/documentation-style-guide/screenshot_area_highlight.png diff --git a/docs/development/contribution-documentation/documentation-style-guide/screenshot_highlights_example.png b/docs/contributions-guide/contribution-documentation/documentation-style-guide/screenshot_highlights_example.png similarity index 100% rename from docs/development/contribution-documentation/documentation-style-guide/screenshot_highlights_example.png rename to docs/contributions-guide/contribution-documentation/documentation-style-guide/screenshot_highlights_example.png diff --git a/docs/development/contribution-documentation/documentation-style-guide/screenshot_numberedlabels_highlight.png b/docs/contributions-guide/contribution-documentation/documentation-style-guide/screenshot_numberedlabels_highlight.png similarity index 100% rename from docs/development/contribution-documentation/documentation-style-guide/screenshot_numberedlabels_highlight.png rename to docs/contributions-guide/contribution-documentation/documentation-style-guide/screenshot_numberedlabels_highlight.png diff --git a/docs/contributions-guide/give-back-to-community/README.md b/docs/contributions-guide/give-back-to-community/README.md new file mode 100644 index 000000000000..11ef22eea0dc --- /dev/null +++ b/docs/contributions-guide/give-back-to-community/README.md @@ -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. diff --git a/docs/contributions-guide/give-back-to-community/openproject-user-guide-create-project-plan.gif b/docs/contributions-guide/give-back-to-community/openproject-user-guide-create-project-plan.gif new file mode 100644 index 000000000000..86bdb3c00e5b Binary files /dev/null and b/docs/contributions-guide/give-back-to-community/openproject-user-guide-create-project-plan.gif differ diff --git a/docs/contributions-guide/give-back-to-community/openproject-user-guide-edit-project-plan.gif b/docs/contributions-guide/give-back-to-community/openproject-user-guide-edit-project-plan.gif new file mode 100644 index 000000000000..1e3e21b26a77 Binary files /dev/null and b/docs/contributions-guide/give-back-to-community/openproject-user-guide-edit-project-plan.gif differ diff --git a/docs/contributions-guide/give-back-to-community/openproject-user-guide-select-gantt-charts-module.png b/docs/contributions-guide/give-back-to-community/openproject-user-guide-select-gantt-charts-module.png new file mode 100644 index 000000000000..466e10d66b95 Binary files /dev/null and b/docs/contributions-guide/give-back-to-community/openproject-user-guide-select-gantt-charts-module.png differ diff --git a/docs/development/translate-openproject/GitHub-CrowdIn-OP.png b/docs/contributions-guide/translate-openproject/GitHub-CrowdIn-OP.png similarity index 100% rename from docs/development/translate-openproject/GitHub-CrowdIn-OP.png rename to docs/contributions-guide/translate-openproject/GitHub-CrowdIn-OP.png diff --git a/docs/development/translate-openproject/README.md b/docs/contributions-guide/translate-openproject/README.md similarity index 98% rename from docs/development/translate-openproject/README.md rename to docs/contributions-guide/translate-openproject/README.md index f41c4c8913e9..f3976cf99638 100644 --- a/docs/development/translate-openproject/README.md +++ b/docs/contributions-guide/translate-openproject/README.md @@ -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 --- @@ -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). diff --git a/docs/development/translate-openproject/crowdin-editor.png b/docs/contributions-guide/translate-openproject/crowdin-editor.png similarity index 100% rename from docs/development/translate-openproject/crowdin-editor.png rename to docs/contributions-guide/translate-openproject/crowdin-editor.png diff --git a/docs/development/translate-openproject/crowdin-language-overview.png b/docs/contributions-guide/translate-openproject/crowdin-language-overview.png similarity index 100% rename from docs/development/translate-openproject/crowdin-language-overview.png rename to docs/contributions-guide/translate-openproject/crowdin-language-overview.png diff --git a/docs/development/translate-openproject/crowdin-multi-translation.png b/docs/contributions-guide/translate-openproject/crowdin-multi-translation.png similarity index 100% rename from docs/development/translate-openproject/crowdin-multi-translation.png rename to docs/contributions-guide/translate-openproject/crowdin-multi-translation.png diff --git a/docs/development/translate-openproject/crowdin-overview.png b/docs/contributions-guide/translate-openproject/crowdin-overview.png similarity index 100% rename from docs/development/translate-openproject/crowdin-overview.png rename to docs/contributions-guide/translate-openproject/crowdin-overview.png diff --git a/docs/development/translate-openproject/fair-language/README.md b/docs/contributions-guide/translate-openproject/fair-language/README.md similarity index 100% rename from docs/development/translate-openproject/fair-language/README.md rename to docs/contributions-guide/translate-openproject/fair-language/README.md diff --git a/docs/development/contribution-documentation/README.md b/docs/development/contribution-documentation/README.md deleted file mode 100644 index 39055ad8e01f..000000000000 --- a/docs/development/contribution-documentation/README.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_navigation: - title: Contribute to documentation - priority: 999 -description: Overview of the OpenProject documentation -keywords: contribution, documentation, documentation process ---- - -# Contribute to the OpenProject documentation - -## How do I get access to the OpenProject Community installation? - -To get an account for community.openproject.org, please write an email with the subject 'Joining community' to [support@openproject.com](mailto:support@openproject.com), if you would like to join our Community. We will then invite you as soon as possible. - -## 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 [here](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/). - -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/). diff --git a/docs/faq/README.md b/docs/faq/README.md index fe32c403a21b..462983058f16 100644 --- a/docs/faq/README.md +++ b/docs/faq/README.md @@ -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). diff --git a/docs/release-notes/12/12-0-7/README.md b/docs/release-notes/12/12-0-7/README.md index 4baf3e484be6..667a1c216eef 100644 --- a/docs/release-notes/12/12-0-7/README.md +++ b/docs/release-notes/12/12-0-7/README.md @@ -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 [info@openproject.com](mailto:info@openproject.com) +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 [info@openproject.com](mailto:info@openproject.com) ## Custom plugins in packaged installations diff --git a/docs/release-notes/13-4-0/README.md b/docs/release-notes/13-4-0/README.md index e23756b496e8..39f389fa5280 100644 --- a/docs/release-notes/13-4-0/README.md +++ b/docs/release-notes/13-4-0/README.md @@ -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! diff --git a/docs/release-notes/14-0-0/README.md b/docs/release-notes/14-0-0/README.md index 8d7b81dc0e3c..185f90706439 100644 --- a/docs/release-notes/14-0-0/README.md +++ b/docs/release-notes/14-0-0/README.md @@ -297,4 +297,4 @@ Silas Kropf, Philipp Schulz, Benjamin Rönnau, Mario Haustein, Matt User, Mario Last but not least, we are very grateful for our very engaged translation contributors on Crowdin, who translated quite a few OpenProject strings! This release we would like to highlight user [izzahk](https://crowdin.com/profile/izzahk) who has done an outstanding number of translations for the Malaysian language in recent weeks. -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! diff --git a/docs/release-notes/14-1-0/README.md b/docs/release-notes/14-1-0/README.md index aa2488be3e18..21f6ca66ec98 100644 --- a/docs/release-notes/14-1-0/README.md +++ b/docs/release-notes/14-1-0/README.md @@ -190,4 +190,4 @@ Also thanks for finding and responsibly disclosing the CVE-2024-135224 vulnerabi Last but not least, we are very grateful for our very engaged translation contributors on Crowdin, who translated quite a few OpenProject strings! This release we would like to highlight user [Syvert](https://crowdin.com/profile/syvert) who has done an outstanding number of translations for the Norwegian language in recent weeks. -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! diff --git a/docs/release-notes/14-2-0/README.md b/docs/release-notes/14-2-0/README.md index 851475f6828f..195801e4fd78 100644 --- a/docs/release-notes/14-2-0/README.md +++ b/docs/release-notes/14-2-0/README.md @@ -125,4 +125,4 @@ A very special thank you goes to the City of Cologne for sponsoring features on Last but not least, we are very grateful for our very engaged translation contributors on Crowdin, who translated quite a few OpenProject strings! This release we would like to highlight user [aniessalam](https://crowdin.com/profile/aniessalam) who has done an outstanding number of translations for the Malay language in recent weeks. -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! diff --git a/docs/release-notes/14-3-0/README.md b/docs/release-notes/14-3-0/README.md index e5fd4a780e53..23a9739840c8 100644 --- a/docs/release-notes/14-3-0/README.md +++ b/docs/release-notes/14-3-0/README.md @@ -192,4 +192,4 @@ A thank you also goes to Eric Guo for contributing the Date zoom based on calend Last but not least, we are very grateful for our very engaged translation contributors on Crowdin, who translated quite a few OpenProject strings! This release we would like to highlight user [Todor Belov](https://crowdin.com/profile/todor.belov), who has done an outstanding number of translations for the Bulgarian language in recent weeks. -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! diff --git a/docs/release-notes/14-5-0/README.md b/docs/release-notes/14-5-0/README.md index cb0b018c7fce..b86f02b92407 100644 --- a/docs/release-notes/14-5-0/README.md +++ b/docs/release-notes/14-5-0/README.md @@ -214,4 +214,4 @@ Last but not least, we are very grateful for our very engaged translation contri - [Sebvita_devinci](https://crowdin.com/profile/sebvita_devinci), for proof reading French translations. - [Alin Marcu](https://crowdin.com/profile/deconfcom), for proof reading Romanian translations. -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! diff --git a/docs/release-notes/14-6-0/README.md b/docs/release-notes/14-6-0/README.md index 1e7eb256be9e..3efd7683c6c6 100644 --- a/docs/release-notes/14-6-0/README.md +++ b/docs/release-notes/14-6-0/README.md @@ -143,4 +143,4 @@ Last but not least, we are very grateful for our very engaged translation contri - [BigSeung](https://crowdin.com/profile/BigSeung), for translations into Korean. - [Raffaele Brevetti](https://crowdin.com/profile/rbrevetti), for translations into Italian. -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! diff --git a/docs/release-notes/15-0-0/README.md b/docs/release-notes/15-0-0/README.md index 7af154f24e35..809db56fbba1 100644 --- a/docs/release-notes/15-0-0/README.md +++ b/docs/release-notes/15-0-0/README.md @@ -235,4 +235,4 @@ Last but not least, we are very grateful for our very engaged translation contri - [hmmftg](https://crowdin.com/profile/hmmftg), for a great number of translations into Persian. - [william](https://crowdin.com/profile/WilliamFromTW), for a great number of translations into Chinese Simplified and Chinese Traditional. -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! diff --git a/docs/system-admin-guide/system-settings/languages/README.md b/docs/system-admin-guide/system-settings/languages/README.md index d9ce3c840d3e..a3cf4db9b564 100644 --- a/docs/system-admin-guide/system-settings/languages/README.md +++ b/docs/system-admin-guide/system-settings/languages/README.md @@ -14,6 +14,6 @@ The Languages page lets you select languages you would like to activate from the At the moment there are over 30 languages available. > [!NOTE] -> Many languages are translated by the community. We highly appreciate if you want to [help translating OpenProject to your language](../../../development/translate-openproject). +> Many languages are translated by the community. We highly appreciate if you want to [help translating OpenProject to your language](../../../contributions-guide/translate-openproject). You can [choose your language in your user profile](../../../user-guide/account-settings/#change-your-language).