Documentation Translation Guidelines

Home > Knowledge Base > Documentation Translation Guidelines

Documentation Translation Guidelines

Keystone's source language is English. We have a Chinese translation currently available. A Spanish translation will be coming soon. Any new documentation should include the source language before it can be merged.

In order to keep the process open and available to any who wishes to contribute we have developed the following guidelines to follow.

When should a new documentation issue be created?

1. Features that should be documented.
2. PR's that require new documentation.
3. PR's that submit new documentation to be translated.
4. PR's that submit significant updates to current documentation. Typos, grammer, and other small language specific updates do not require a new issue.
5. Missing documentation from a specific language.
6. Current documentation that needs to be addressed.

How should the documentation issue be created?

1. The title should describe the feature to be documented.
2. Add the global TAG needs documentation`
3. Add TAGS for each language that needs documentation.
4. Link the PR from the source language addition. If no PR is available include a link to the source file (including the beginning line number). eg: https://github.com/keystonejs/keystone/blob/master/docs/content/en/pages/docs/configuration.jade#L218-L237
5. Describe what needs to be documented or any issues that need attention.

How should the documentation issue be managed?

1. If you would like to accept the task of creating a translation or are thinking about doing so make a comment on the issue. The comment can be as simple as considering or in progress. If you claim a translation you can be assigned to the issue.
2. Once a PR has been accepted and merged the TAG specific to the languages involved should be removed.
3. Once all language TAGS have been removed the issue should be closed.