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

chore: New documentation page translations_states and updated project settings #914

Merged
merged 2 commits into from
Apr 8, 2025
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
18 changes: 12 additions & 6 deletions platform/projects_and_organizations/project_settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,21 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';

In project settings, you can edit the basic properties of your project.

- **project name**
- **description** - displayed in the project dashboard (can be formatted with Markdown)
- **base language** - the language that is used as a base for translating to other languages
- **default namespace** - preselected namespace when creating a new key
- **Project Name**
- **Description** - displayed in the project dashboard (can be formatted with Markdown)
- **Base language** - the language that is used as a base for translating to other languages
- **Use namespaces** - a checkbox to enable namespaces
- **Default namespace** - preselected namespace when creating a new key

Then, there are the options to leave the project, delete it or transfer the ownership to another organization.

## Enabling Namespaces

Toggle "Use namespaces" checkbox in "Project settings" to choose your default namespace. After enabling it, a "Default namespace" tab will appear below it where you can choose one.
You can read our article about [namespaces](https://docs.tolgee.io/platform/translation_keys/namespaces) to learn how to use them.

<ScreenshotWrapper
src="/img/docs/platform/project-settings.webp"
src="/img/docs/platform/project-settings-example.webp"
alt="Project settings"
/>

Expand All @@ -26,6 +32,6 @@ By default, Tolgee visualizes ICU placeholders in the translation editor and int
If you want to disable this feature, you can do so in the advanced tab of the project settings.

<ScreenshotWrapper
src="/img/docs/platform/project_settings_icu.webp"
src="/img/docs/platform/advanced-project-settings.webp"
alt="Project settings > ICU placeholders support"
/>
72 changes: 72 additions & 0 deletions platform/translation_process/translation_states.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
id: translation_states
title: Understanding Translation States
sidebar_label: Translation States
description: Tolgee categorizes translations into three states, each visually shown by a colored bar near the translated key.
---

import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';

Translation management is important when you want to ensure that the quality of the text you translate meets your standards. Changing each translation's status helps track whether the translation is ready or still needs to be reviewed. This feature allows you to ensure that everything is prepared before finalizing your translation.

## The Three Translation States

Tolgee categorizes translations into three states, each visually shown by a colored bar near the translated key:

- **Gray**: Untranslated
- **Yellow**: Translated but not reviewed
- **Green**: Reviewed

<ScreenshotWrapper
src="/img/docs/platform/translation-states-example.png"
alt="Quality assurance in translation three states"
/>

The color-coding feature helps you to check the status of a translation. This system makes it visual and easy to go through so that you can quickly check if you have completed everything.

## Working with Translation States

You can find the translation keys and the translations in Translation View on Tolgee. You will see translations in your base language. To show more languages of your project, you can do the following:

1. Click on the language bar at the top right that shows the currently selected languages
2. Select the project languages that you want to see and check
3. Now you can view all the translations and work with the states

### Quality Assurance in Translation

The reviewer of the project usually performs the following functions with Tolgee:

- **Approving**: Changing a translation from "Translated" to "Reviewed" status. It can be done by clicking the "Mark as Reviewed" button at the top right corner of the translation.
- **Reverting Approvals**: If a previously approved translation needs changes, the same button to change it back to "Translated" status can be used
- **Comments**: See the string history in the bottom part of the side panel when the translation is open for editing
- **Tracking Changes:** The history of changes can be found after clicking Edit

![Translation Guide](/img/docs/platform/tolgee-translation-states-guide.gif)

## Benefits of State-Based Translation Management

There are a few advantages of the state-based approach:

1. Visual indicators show your project progress
2. It makes sure translations meet quality standards after the review
3. Saves time and improves collaboration

Additionally, the history can be checked to see which decisions were made and when they were made, and comments let you discuss some issues without leaving the platform, so you know what is being discussed.

## Useful Workflows for Translation Quality Management

When using Tolgee's state system, teams can set up different localization workflows. An example of such a workflow is as follows:

| State | Action Required | Responsibility |
| --- | --- | --- |
| Gray | Translation needed | Translator |
| Yellow | Quality review needed | Reviewer |
| Green | Ready for deployment | Not needed |

The approach prevents the premature deployment of unreviewed content. It keeps clear ownership at each stage, which helps bigger teams.

## Manage Localization Easier

Tolgee's translation states help transform localization from chaos to a manageable workflow. Tolgee helps teams of different sizes deliver accurate, high-quality translations. It provides clear guides for translation progress and assists with proper quality assurance.

Ready to make your localization faster and easier? Try Tolgee's platform today and see how state management of translation can improve your global strategy.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.