From 5000564f12156f6547245808f3ee5128437e2fe0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Kuchy=C5=88ka=20=28Anty=29?= Date: Sat, 18 Jul 2026 16:50:08 +0200 Subject: [PATCH] docs: document Community Translation feature Add a Community Translation page covering public projects, the community permission, the public projects discovery page, reviewing community suggestions, and unpublishing. Cross-link and update related pages: - suggestions: two accept actions (Accept only / Accept and decline others) and the three-suggestions-with-Show-all display - project_settings: Public project advanced setting - members: community-permission note on public projects - sidebar: new page entry --- .../community_translation.mdx | 103 ++++++++++++++++++ .../projects_and_organizations/members.mdx | 4 + .../project_settings.mdx | 4 + .../suggestions.mdx | 10 +- sidebarPlatform.js | 1 + 5 files changed, 120 insertions(+), 2 deletions(-) create mode 100644 platform/projects_and_organizations/community_translation.mdx diff --git a/platform/projects_and_organizations/community_translation.mdx b/platform/projects_and_organizations/community_translation.mdx new file mode 100644 index 000000000..f6f1e31d1 --- /dev/null +++ b/platform/projects_and_organizations/community_translation.mdx @@ -0,0 +1,103 @@ +--- +id: community_translation +title: Community Translation +sidebar_label: Community Translation +image: /img/og-images/platform.png +description: Make a project public so anyone signed in can help translate it. Community members propose suggestions and comment without becoming paid members. +--- + +Open-source and community-driven projects often want help from their users to reach more +languages, but inviting every willing volunteer as a project member does not scale. Each member +takes up a paid seat, gains access to project internals, and can change translations directly. +You want the reach of a crowd without handing out that level of access. + +Community Translation solves this. Make a project **public** and anyone signed in can find it, +open a limited view, and propose [translation suggestions](./suggestions.mdx) or leave +[comments](/platform/translation_process/comments). They never become members, never take a paid +seat, and can never overwrite your existing translations. You stay in control and accept only the +suggestions you want. + +## Make a project public + +Publishing a project is what turns on community translation for it. Only the **organization +owner** (or a server administrator on self-hosted instances) can change this, because it exposes +the project's translations to anyone with an account. + +Go to `Project settings` > `Advanced` and find the `Public project` section. Turn on +`Make this project public`. + +Tolgee asks you to confirm, because publishing changes who can reach the project. When you make a +project public, anyone signed in will be able to find it on the public projects page and propose +suggestions. They will not become members and cannot edit existing translations. + +If you can't see the `Public project` section or the switch is disabled, you are not the +organization owner. Ask an owner to publish the project for you. + +## What community members can do + +When a project is public, every signed-in user gets a **community permission** on it. This +permission is a limited subset of the [`View` role](./members.mdx#permissions) plus the ability to +suggest and comment. A community member can + +- View translations and screenshots in **all languages** +- View the project activity +- Propose [translation suggestions](./suggestions.mdx) +- [Comment](/platform/translation_process/comments) on translations, for example to flag a wrong + or machine-generated translation + +The community permission never lets anyone + +- Overwrite an existing translation or change its [state](/platform/translation_process/translation_states) + (translated or reviewed) +- Add or remove languages +- See the project members or their email addresses +- Change project settings + +Community members are **not** project members. They do not appear in your members list, they do +not use a paid seat, and publishing a project never changes your billing. To give someone the +ability to edit translations directly, [invite them as a member](./members.mdx#how-to-add-members-to-your-project) +instead. + +:::info +The community permission applies only to **signed-in** users. Visitors who are not logged in can +browse the public projects page but must log in before they can open a project or suggest anything. +::: + +## How contributors find your project + +Public projects are listed on the community translations page at +[`/public-projects`](https://app.tolgee.io/public-projects). Anyone can open this page, even +without an account, browse the projects, and search for one to help with. + +Visitors who are not signed in see `Log in` and `Sign up` buttons in the top bar. Opening a +project or proposing a suggestion requires an account, so a new contributor registers or logs in +first, then opens your project in the limited community view. + +Each row shows the project name with an outlined `public` badge and the owning organization, +along with the key count, translation-state bar, and languages, so a contributor can pick a +project and a language that needs work at a glance. + +## Review community suggestions + +Community members propose changes as suggestions, never as direct edits, so nothing they submit +goes live until you accept it. Open the translation in the editor and review the incoming +suggestions the same way you review any other suggestion. + +When a suggestion is good, you have two ways to accept it. `Accept only` promotes that suggestion +to the live translation and leaves the other suggestions open, which is useful when you want to +keep comparing alternatives. `Accept and decline others` promotes the suggestion and dismisses the +competing ones in a single step. + +For the full suggestion workflow, including how to enable direct suggestions for your own members, +read [Translation Suggestions](./suggestions.mdx). + +## Make a project private again + +To stop accepting community translations, go back to `Project settings` > `Advanced` and turn off +`Make this project public`. Tolgee confirms the change, because the community loses access +immediately. + +Once the project is private, it is no longer listed on the public projects page and community +members can no longer open it. Members you invited directly keep their access and everything they +contributed stays in place. Nothing about the project view changes for your members, the community +simply loses the permission to reach it. diff --git a/platform/projects_and_organizations/members.mdx b/platform/projects_and_organizations/members.mdx index 74f05ddd2..986d0b71f 100644 --- a/platform/projects_and_organizations/members.mdx +++ b/platform/projects_and_organizations/members.mdx @@ -38,6 +38,10 @@ You can choose the permissions that you want to give to the member. The permissi alt="basic permissions" /> +:::info +On a [public project](./community_translation.mdx), any signed-in user also gets a limited **community permission** that lets them view and suggest without being a member. Community members do not appear in this list and do not use a paid seat. +::: + ### Advanced Granular Permissions :::info Feature availability diff --git a/platform/projects_and_organizations/project_settings.mdx b/platform/projects_and_organizations/project_settings.mdx index 1d8578729..2939d7d82 100644 --- a/platform/projects_and_organizations/project_settings.mdx +++ b/platform/projects_and_organizations/project_settings.mdx @@ -23,6 +23,10 @@ Then, there are the project configuration options to leave the project, delete i ## Advanced project settings +### Public project + +When enabled, the project becomes publicly discoverable and any signed-in user can propose translation suggestions without becoming a member. Only the organization owner can change this. [Read more](./community_translation.mdx) + ### Suggestions mode When enabled, users can add suggestions instead of editing the translation directly. [Read more](./suggestions.mdx) diff --git a/platform/projects_and_organizations/suggestions.mdx b/platform/projects_and_organizations/suggestions.mdx index 121347244..f7176ca16 100644 --- a/platform/projects_and_organizations/suggestions.mdx +++ b/platform/projects_and_organizations/suggestions.mdx @@ -10,6 +10,8 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper'; Suggestions allow users to propose changes to strings without editing them directly. The actual string value is changed after a reviewer approves the suggestion. +Suggestions are also how [community translation](./community_translation.mdx) works. On a public project, anyone signed in can suggest without becoming a member. + ### How to enable suggestions Go to `Project settings` > `Advanced` > `Suggestions mode`. @@ -51,9 +53,13 @@ This is the moment when it will replace the existing translation. alt="Suggestion is accepted" /> -If there are multiple suggestions, you are declining the others by accepting one. +When there are multiple suggestions on a string, you choose how accepting one affects the rest. +`Accept only` promotes the suggestion to the live translation and leaves the other suggestions +open, so you can keep comparing them. `Accept and decline others`, in the suggestion's `⋮` menu, +promotes the suggestion and dismisses the competing ones in a single step. -All previously accepted/declined suggestions are found under a "Show all" checkbox. +Tolgee shows up to three suggestions on a string at once. If there are more, use `Show all` to see +the rest. All previously accepted and declined suggestions are also found under `Show all`.