Skip to content

Commit f19df10

Browse files
committed
Clean up localization.md
1 parent 6face83 commit f19df10

File tree

1 file changed

+45
-46
lines changed

1 file changed

+45
-46
lines changed

content/en/docs/contribute/localization.md

Lines changed: 45 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ the docs for a different language.
2323

2424
You can help add or improve the content of an existing localization. In
2525
[Kubernetes Slack](https://slack.k8s.io/), you can find a channel for each
26-
localization. There is also a general [SIG Docs Localizations Slack
27-
channel](https://kubernetes.slack.com/messages/sig-docs-localizations) where you
28-
can say hello.
26+
localization. There is also a general
27+
[SIG Docs Localizations Slack channel](https://kubernetes.slack.com/messages/sig-docs-localizations)
28+
where you can say hello.
2929

3030
{{< note >}}
3131
For extra details on how to contribute to a specific localization,
@@ -34,9 +34,9 @@ look for a localized version of this page.
3434

3535
### Find your two-letter language code
3636

37-
First, consult the [ISO 639-1
38-
standard](https://www.loc.gov/standards/iso639-2/php/code_list.php) to find your
39-
localization's two-letter language code. For example, the two-letter code for
37+
First, consult the
38+
[ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php)
39+
to find your localization's two-letter language code. For example, the two-letter code for
4040
Korean is `ko`.
4141

4242
Some languages use a lowercase version of the country code as defined by the
@@ -45,8 +45,7 @@ language code is `pt-br`.
4545

4646
### Fork and clone the repo
4747

48-
First, [create your own
49-
fork](/docs/contribute/new-content/open-a-pr/#fork-the-repo) of the
48+
First, [create your own fork](/docs/contribute/new-content/open-a-pr/#fork-the-repo) of the
5049
[kubernetes/website](https://github.com/kubernetes/website) repository.
5150

5251
Then, clone your fork and `cd` into it:
@@ -120,8 +119,8 @@ localization teams to collaborate on defining and documenting the processes for
120119
creating localized contribution guides. In addition, the SIG Docs localization
121120
subgroup looks for opportunities to create and share common tools across
122121
localization teams and identify new requirements for the SIG Docs Leadership
123-
team. If you have questions about this meeting, please inquire on the [SIG Docs
124-
Localizations Slack channel](https://kubernetes.slack.com/messages/sig-docs-localizations).
122+
team. If you have questions about this meeting, please inquire on the
123+
[SIG Docs Localizations Slack channel](https://kubernetes.slack.com/messages/sig-docs-localizations).
125124

126125
You can also create a Slack channel for your localization in the
127126
`kubernetes/community` repository. For an example of adding a Slack channel, see
@@ -220,7 +219,7 @@ Open a PR against the
220219
[`cncf/foundation`](https://github.com/cncf/foundation/tree/main/code-of-conduct-languages)
221220
repository to add the code of conduct in your language.
222221

223-
### Setting up the OWNERS files
222+
### Set up the OWNERS files
224223

225224
To set the roles of each user contributing to the localization, create an
226225
`OWNERS` file inside the language-specific subdirectory with:
@@ -313,7 +312,7 @@ a GitHub ID, email address, [Slack channel](https://slack.com/), or another
313312
method of contact. You must also provide a link to your localized Community Code
314313
of Conduct.
315314

316-
### Launching your new localization
315+
### Launch your new localization
317316

318317
When a localization meets the requirements for workflow and minimum output, SIG
319318
Docs does the following:
@@ -323,7 +322,7 @@ Docs does the following:
323322
[Cloud Native Computing Foundation](https://www.cncf.io/about/)(CNCF)
324323
channels, including the [Kubernetes blog](/blog/).
325324

326-
## Translating content
325+
## Localize content
327326

328327
Localizing *all* the Kubernetes documentation is an enormous task. It's okay to
329328
start small and expand over time.
@@ -361,7 +360,7 @@ extensive human review to meet minimum standards of quality.
361360
To ensure accuracy in grammar and meaning, members of your localization team
362361
should carefully review all machine-generated translations before publishing.
363362

364-
### Translating SVG images
363+
### Localize SVG images
365364

366365
The Kubernetes project recommends using vector (SVG) images where possible, as
367366
these are much easier for a localization team to edit. If you find a raster
@@ -375,33 +374,33 @@ used in the Kubernetes documentation to illustrate concepts, workflows,
375374
and diagrams.
376375

377376
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](/docs/contribute/new-content/open-a-pr/#preview-locally).
377+
within the SVG image that need to be translated. These elements typically
378+
include labels, captions, annotations, or any text that conveys information.
379+
380+
1. **Editing SVG files**: SVG files are XML-based, which means they can be
381+
edited using a text editor. However, it's important to note that most of the
382+
documentation images in Kubernetes already convert text to curves to avoid font
383+
compatibility issues. In such cases, it is recommended to use specialized SVG
384+
editing software, such as Inkscape, for editing, open the SVG file and locate
385+
the text elements that require translation.
386+
387+
1. **Translating the text**: Replace the original text with the translated
388+
version in the desired language. Ensure the translated text accurately conveys
389+
the intended meaning and fits within the available space in the image. The Open
390+
Sans font family should be used when working with languages that use the Latin
391+
alphabet. You can download the Open Sans typeface from here:
392+
[Open Sans Typeface](https://fonts.google.com/specimen/Open+Sans).
393+
394+
1. **Converting text to curves**: As already mentioned, to address font
395+
compatibility issues, it is recommended to convert the translated text to
396+
curves or paths. Converting text to curves ensures that the final image
397+
displays the translated text correctly, even if the user's system does not
398+
have the exact font used in the original SVG.
399+
400+
1. **Reviewing and testing**: After making the necessary translations and
401+
converting text to curves, save and review the updated SVG image to ensure
402+
the text is properly displayed and aligned. Check
403+
[Preview your changes locally](/docs/contribute/new-content/open-a-pr/#preview-locally).
405404

406405
### Source files
407406

@@ -414,7 +413,7 @@ To find source files for your target version:
414413
1. Navigate to the Kubernetes website repository at
415414
https://github.com/kubernetes/website.
416415

417-
2. Select a branch for your target version from the following table:
416+
1. Select a branch for your target version from the following table:
418417

419418
Target version | Branch
420419
-----|-----
@@ -481,7 +480,7 @@ Per CNCF policy, the localization teams must upload their meetings to the SIG
481480
Docs YouTube playlist. A SIG Docs Co-Chair or Tech Lead can help with the
482481
process until SIG Docs automates it.
483482

484-
## Branching strategy
483+
## Branch strategy
485484

486485
Because localization projects are highly collaborative efforts, we
487486
encourage teams to work in shared localization branches - especially
@@ -506,15 +505,15 @@ To collaborate on a localization branch:
506505
branch `dev-1.12-de.1` directly against the `kubernetes/website` repository,
507506
based on the source branch for Kubernetes v1.12.
508507

509-
2. Individual contributors open feature branches based on the localization
508+
1. Individual contributors open feature branches based on the localization
510509
branch.
511510

512511
For example, a German contributor opens a pull request with changes to
513512
`kubernetes:dev-1.12-de.1` from `username:local-branch-name`.
514513

515-
3. Approvers review and merge feature branches into the localization branch.
514+
1. Approvers review and merge feature branches into the localization branch.
516515

517-
4. Periodically, an approver merges the localization branch with its source
516+
1. Periodically, an approver merges the localization branch with its source
518517
branch by opening and approving a new pull request. Be sure to squash the
519518
commits before approving the pull request.
520519

0 commit comments

Comments
 (0)