docs: Community Translation feature - #1130
Conversation
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Cover the Contributors release (contributors tab, community projects
page, My contributions only toggle) and add UI screenshots to the
Community Translation, Suggestions, and Member Management pages.
- community_translation: contributors ('See who has contributed'),
community projects page + 'My contributions only', screenshots for
the public toggle, public projects page, community projects, the two
accept actions, and the contributors tab
- members: 'Community contributors' section with the Team/Community tabs
- suggestions: screenshot of the two accept actions
5000564 to
f756e51
Compare
…highlight The ScreenshotWrapper renders window chrome, so interior crops looked wrong. Retake the public toggle, contributors tab, community projects page, and suggestion accept actions as full-viewport shots with the relevant area outlined in red.
…out highlight These two capture the page's main content, so no red highlight is needed. Also fix their sizing: trim the excess width (side gutters) and, for the contributors tab, the trailing vertical whitespace.
Condense the Community Translation and Member Management pages and fix subject/verb and article agreement in the community-permissions wording.
Use the list view to match the other screenshots, and tighten the highlight to just the Accept only button and the Accept and decline others menu item.
| 'projects_and_organizations/import', | ||
| 'projects_and_organizations/export', | ||
| 'projects_and_organizations/suggestions', | ||
| 'projects_and_organizations/community_translation', |
There was a problem hiding this comment.
I am thinking about the location of this file. Naturally I was looking for it in the translation process section.
| [invite them as a member](./members.mdx#how-to-add-members-to-your-project) instead. | ||
|
|
||
| :::info | ||
| If your project is published under an open source license, contact us for a free Team license. |
There was a problem hiding this comment.
This is actually a Business plan for non-commercial open-source.
Also contact us might be a mailto link to sales@tolgee.io
| 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. | ||
|
|
||
| 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). |
There was a problem hiding this comment.
This is and is not a tl;dr paragraph.
To improve this:
- tl;dr should answer the WHO - WHAT - HOW - WHAT's NEXT
- first sentence should define the feature
- avoid long and complicated sentences
- use keywords - here: public project, contributors, volunteers, open source localization, suggest translations, review and approve, without adding members...
- no links in the tl;dr
- should use self-contained information valid even when cited (anyone signed in --> anyone with Tolgee account)
Might be changed to:
Community Translation is a Tolgee feature for projects that want translation help from their community. Make a project public and anyone with a Tolgee account can browse it, suggest translations, and leave comments.
Contributors cannot edit anything directly. Project members review the suggestions and accept the ones they like. No need to invite volunteers as members.
| 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). | ||
|
|
There was a problem hiding this comment.
I would restructure this a bit.
Start with an intro paragraph describing what is coming next (so the users can jump straight into their pov).
From the project owner point of view:
- make a project public
- share the project with your community (=how contributors find your project)
- review community suggestions
- see who has contributed
From the contributor point of view:
- what community members can do
- find projects you have contributed to
| ## How contributors find your project | ||
|
|
||
| Public projects are listed on the community translations page at | ||
| [`/public-projects`](https://app.tolgee.io/public-projects). |
There was a problem hiding this comment.
I would share a full url into the anchor with an extra info about self-hosted instances. This is critical to understand the feature.
| Contributors appear on the project's [Members](./members.mdx) page. As soon as a public project has | ||
| its first contributor, the page splits into two tabs. The `Team` tab lists your project members as | ||
| usual, and the `Community` tab lists everyone who has contributed without being a member. |
There was a problem hiding this comment.
This might be organized as two bullets - team and community.
| 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. |
There was a problem hiding this comment.
This might be organized a two bullets.
| ### 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) | ||
|
|
There was a problem hiding this comment.
The public project option is missing on the screenshot. Also, I would consider moving the screenshot a little closer to the top, because when you start reading the section, you have no idea the screenshot exists.
|
|
||
| ## Community contributors | ||
|
|
||
| On a [public project](./community_translation.mdx), people who are not members can suggest and |
There was a problem hiding this comment.
the button public project should lead to a public project anchor, not a community translation header.
| <ScreenshotWrapper | ||
| src="/img/docs/platform/community-translation/community-projects.webp" | ||
| alt="Community projects page with the My contributions only toggle enabled" | ||
| /> |
There was a problem hiding this comment.
This screenshot needs a little bit more description (or crop the upper part if it is not necessary).
- does the top row mean this is behind login?
- what does the my contributions toggle do?
- community translation behave as one project in the user point of view?
2 participants
Documents the Community Translation feature, including the v1.1 "Contributors" release. Rebased on latest
main; includes UI screenshots.New page
platform/projects_and_organizations/community_translation.mdx— the feature hub:/public-projects, logged-out browse, log in to contribute)Community translationorg-switcher entry, community projects page,My contributions onlytoggle)Accept onlyvsAccept and decline others)Invite to Team)Updated pages
Show alldisplayPublic projectadvanced settingCommunity contributorssection (Team/Community tabs) and community-permission noteScreenshots
Captured against a local instance (billing enabled) with a seeded public project and non-member contributors: public toggle, public projects page, contributors tab, community projects page, and the two accept actions.
Scope notes