Docs

You can check out how to get started with Sleekdocs Translate with React and Angular via the links below:

React, i18next and translations in sleekdocs
Angular, ngx-translate and translations in sleekdocs

Terminology

  • Team: Users may belong to one or multiple teams. Each team consists of users managing a variety of projects.
  • Project: Defined as an application in the process of translation. For each project, you are required to add one or more target languages for translation.
  • Publish: Publishing a translation assigns it a revision number and readies it for deployment to an environment such as development, test, or production.
  • Deploy: Deploying a published translation involves generating the target translation file, uploading it to the Sleekdocs CDN, and making it available within your application.

Team Roles and Permissions

Users can be designated with one of three team roles:

  • Admin: Administrators have the authority to manage team members and oversee all projects within the team.
  • Creator: Creators can create projects and manage (create, rename, delete) translation keys for a project.
  • Editor: Editors can only modify existing translations.

Note: Specific permissions are required for publishing and deploying translations for a project, irrespective of the user’s team role.

Getting Started

New users logging in for the first time via supported external identity providers (Microsoft, Google, or GitHub) will have an account created automatically. Accessing Sleekdocs through an invitation link assigns you to the inviting team. Without an invitation link, you need to form a team to advance to project creation.

Creating a new project allows you to add languages, select the primary language, and upload existing translation files if available.

Common Tasks

Editing a Translation

To edit, click on the existing translation text to enter “edit mode.” Confirm your changes by clicking “Save”.

Adding a Translation Key

Role Required: Creator

Navigate to the primary language and click the “+” icon in the translations list header. A dialog box will appear for entering the new translation key and its primary language value.

Renaming a Translation Key

Role Required: Creator

Navigate to the primary language and click the key you wish to rename. Enter the new name in the dialog box that appears.

Deleting a Translation Key

Role Required: Creator

To delete a key, first remove all translations by setting their values to empty strings. Then, in the primary language view, use the “Delete key” link in the corresponding translation row.

Security and personal data

Authentication of users is done solely via external identity providers (Microsoft, Google or GitHub). This means that no usernames or passwords are handled by or stored in Sleekdocs Translate. The only personal data we store is the name and e-mail address.