chore: New documentation page translations_states and updated project settings #914
Conversation
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| - **Base language** - the language that is used as a base for translating to other languages | ||
| - **Default namespace** - preselected namespace when creating a new key | ||
|
|
||
| To use namespaces in your project, you need to have namespaces enabled. Toggle "Use namespaces" to choose your default namespace. |
There was a problem hiding this comment.
There is actually Use namespaces checkbox above the default namespace, so it should be added above.
Also I would add separate section called Enabling namespaces
|
|
||
| Then, there are the options to leave the project, delete it or transfer the ownership to another organization. | ||
|
|
||
| <ScreenshotWrapper | ||
| src="/img/docs/platform/project-settings.webp" | ||
| src="/img/docs/platform/project-settings.png" |
There was a problem hiding this comment.
Please always convert images to webp as it is faster to load and so better for seo.
| - **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 |
There was a problem hiding this comment.
My following comment is reffering this part.
| - **Default namespace** - preselected namespace when creating a new key | ||
|
|
||
| To use namespaces in your project, you need to have namespaces enabled. Toggle "Use namespaces" to choose your default namespace. | ||
| You can read our article about [namespaces](https://docs.tolgee.io/js-sdk/namespaces) to learn more. |
There was a problem hiding this comment.
I wouldn't link here to the js-sdk docs, instead, link here: https://docs.tolgee.io/platform/translation_keys/namespaces
| id: translation_states | ||
| title: Understanding Translation States | ||
| sidebar_label: Translation States | ||
| description: Tolgee organizes translations into three states, each visually shown by a colored bar near the translated key. |
There was a problem hiding this comment.
I wouldn't say that states are for organization, please consult chatGPT for better explanation.
|
|
||
| ## The Three Translation States | ||
|
|
||
| Tolgee organizes translations into three states, each visually shown by a colored bar near the translated key: |
There was a problem hiding this comment.
organizes is not the right way to call it.
| alt="Quality assurance in translation three states" | ||
| /> | ||
|
|
||
| The color-coding feature helps managers and translators to check the status of a translation. This system makes it visual and easy to go through, especially if you are working with a large number of keys. |
There was a problem hiding this comment.
I don't think the amount of keys is relevant. What is large? 100, 1000, 10000? It helps event when there is 50 keys...
|
|
||
| ## Working with Translation States | ||
|
|
||
| To see the translation keys and the translations, go to the translation tab in Tolgee. You will see translations in your primary language. To show more languages of your project, you can do the following: |
There was a problem hiding this comment.
We don't call it "translation tab", but translations view.
We don't call it primary language., but base language.
Please create some terminology document where we will store this project glossary.
| - **Approving**: To change a translation from "Translated" to "Reviewed" status, click the "Mark as Reviewed" button at the top right corner of the translation. | ||
| - **Reverting Approvals**: If a previously approved translation needs changes, use the same button to change it back to "Translated" status | ||
| - **Comments**: Use comments to provide feedback or explain why it was not approved | ||
| - **Tracking Changes:** Go to Edit to see the history of changes |
There was a problem hiding this comment.
"Go to Edit", is suddenly changing the explanations to some king of "how to" form.
| - **Tracking Changes:** Go to Edit to see the history of changes | |
| - **Tracking Changes:** See the string history in bottom part of the side panel when translation is open for editing |
|
|
||
| 1. Visual indicators show your project progress | ||
| 2. It makes sure translations meet quality standards after the review | ||
| 3. The history tab shows which decisions were made and when they were made. |
There was a problem hiding this comment.
Not sure if history is relevant to State-Based approach.
No description provided.