Skip to content

Commit 130e589

Browse files
authored
Merge pull request #41605 from Nordix/image-translation-guide/mohammed
Add guide for translating SVG images
2 parents 8b5d26c + 4737689 commit 130e589

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

content/en/docs/contribute/localization.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,48 @@ extensive human review to meet minimum standards of quality.
361361
To ensure accuracy in grammar and meaning, members of your localization team
362362
should carefully review all machine-generated translations before publishing.
363363

364+
### Translating SVG images
365+
366+
The Kubernetes project recommends using vector (SVG) images where possible, as
367+
these are much easier for a localization team to edit. If you find a raster
368+
image that needs localizing, consider first redrawing the English version as
369+
a vector image, and then localize that.
370+
371+
When translating text within SVG (Scalable Vector Graphics) images, it's
372+
essential to follow certain guidelines to ensure accuracy and maintain
373+
consistency across different language versions. SVG images are commonly
374+
used in the Kubernetes documentation to illustrate concepts, workflows,
375+
and diagrams.
376+
377+
1. **Identifying translatable text**: Start by identifying the text elements
378+
within the SVG image that need to be translated. These elements typically
379+
include labels, captions, annotations, or any text that conveys information.
380+
381+
2. **Editing SVG files**: SVG files are XML-based, which means they can be
382+
edited using a text editor. However, it's important to note that most of the
383+
documentation images in Kubernetes already convert text to curves to avoid font
384+
compatibility issues. In such cases, it is recommended to use specialized SVG
385+
editing software, such as Inkscape, for editing, open the SVG file and locate
386+
the text elements that require translation.
387+
388+
3. **Translating the text**: Replace the original text with the translated
389+
version in the desired language. Ensure the translated text accurately conveys
390+
the intended meaning and fits within the available space in the image. The Open
391+
Sans font family should be used when working with languages that use the Latin
392+
alphabet. You can download the Open Sans typeface from here:
393+
[Open Sans Typeface](https://fonts.google.com/specimen/Open+Sans).
394+
395+
4. **Converting text to curves**: As already mentioned, to address font
396+
compatibility issues, it is recommended to convert the translated text to
397+
curves or paths. Converting text to curves ensures that the final image
398+
displays the translated text correctly, even if the user's system does not
399+
have the exact font used in the original SVG.
400+
401+
5. **Reviewing and testing**: After making the necessary translations and
402+
converting text to curves, save and review the updated SVG image to ensure
403+
the text is properly displayed and aligned. Check
404+
[Preview your changes locally](https://kubernetes.io/docs/contribute/new-content/open-a-pr/#preview-locally).
405+
364406
### Source files
365407

366408
Localizations must be based on the English files from a specific release

0 commit comments

Comments
 (0)