diff --git a/.github/review-template.md b/.github/review-template.md index 772849a9be..9f958c9ca5 100644 --- a/.github/review-template.md +++ b/.github/review-template.md @@ -1,7 +1,7 @@ ## Author self-review - [ ] The changes in this PR meet the user experience and goals outlined in the content design plan. -- [ ] I've compared my PR's source changes to staging and reviewed for versioning issues, redirects, the [style guide](https://github.com/github/docs/blob/main/contributing/content-style-guide.md), [content model](https://github.com/github/docs/blob/main/contributing/content-model.md), or [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) rendering problems, typos, and wonky screenshots. +- [ ] I've compared my PR's source changes to staging and reviewed for versioning issues, redirects, the [style guide](https://github.com/github/docs/blob/main/contributing/content-style-guide.md), [content model](https://github.com/github/docs/blob/main/contributing/content-model.md), or [translations guide for writers](https://github.com/github/docs/blob/main/contributing/translations/for-writers.md) rendering problems, typos, and wonky screenshots. - [ ] I've worked through build failures and tests are passing. - [ ] For REST API content, I've verified that endpoints, parameters, and responses are correct and work as expected and provided curl samples below. diff --git a/contributing/README.md b/contributing/README.md index 9e4129f65a..c5f8a04b59 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -12,7 +12,7 @@ Here, you'll find additional information that might be helpful as you work on a - [content templates](./content-templates.md) - handy templates to get you started with a new article - [deployments](./deployments.md) - how our staging and production environments work - [liquid helpers](./liquid-helpers.md) - using liquid helpers for versioning in our docs -- [localization checklist](./localization-checklist.md) - making sure your content is ready to be translated +- [translations guide for writers](./translations/for-writers.md) - making sure your content is ready to be translated - [node versions](./node-versions.md) - our site runs on Node.js - [permalinks](./permalinks.md) - permalinks for article versioning - [redirects](./redirects.md) - configuring redirects in the site diff --git a/contributing/self-review.md b/contributing/self-review.md index 7dc65b407f..ee24412f33 100644 --- a/contributing/self-review.md +++ b/contributing/self-review.md @@ -7,7 +7,7 @@ For content changes, make sure that you: - [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one). - [ ] Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. Remember that lists and tables can be tricky. - [ ] Review the content for technical accuracy. -- [ ] Review the entire pull request using the [localization checklist](localization-checklist.md). +- [ ] Review the entire pull request using the [translations guide for writers](./translations/for-writers.md). - [ ] Copy-edit the changes for grammar, spelling, and adherence to the [style guide](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). - [ ] Check new or updated Liquid statements to confirm that versioning is correct. - [ ] If there are any failing checks in your PR, troubleshoot them until they're all passing. diff --git a/contributing/translations/for-translators.md b/contributing/translations/for-translators.md new file mode 100644 index 0000000000..13f691283f --- /dev/null +++ b/contributing/translations/for-translators.md @@ -0,0 +1,19 @@ +# Translation guide for translators + +## Translated files +We only translate: +- all files `/content` +- `/data/release-notes` +- `/data/reusables` +- `/data/variables` - **except** `/data/variables/product.yml` +- `/data/glossaries/external.yml` +- `/data/product-examples` + +## Translation guidelines +We do not accept translation changes from open source contributors. + +- [ ] Lint all `*.yml` files before submitting to make sure they are valid YAML format. +- [ ] Lint all frontmatter (between the triple dashes at the top of all `/content` files) to make sure they are valid YAML format. +- [ ] Do not translate anything inside of Liquid tags, such as `{% data %}` or `{% ifversion ... %}`, `{% note %}` or `{{ someVariable }}`. +- [ ] Be sure to translate the frontmatter properties `title`, `shortTitle`, `intro`, `permissions` but leave all other keys in each content `.md` file +- [ ] For every `{% ifversion ... %}` there's a `{% endif %}` following it diff --git a/contributing/localization-checklist.md b/contributing/translations/for-writers.md similarity index 98% rename from contributing/localization-checklist.md rename to contributing/translations/for-writers.md index dc75e1c20e..92d80edade 100644 --- a/contributing/localization-checklist.md +++ b/contributing/translations/for-writers.md @@ -1,6 +1,6 @@ -# Localization Prep Checklist +# Translations guide for writers -Use the following checklist to help make your files more translation-friendly. For additional information, refer to the [style guide](content-style-guide.md). +Use the following checklist to help make your files more translation-friendly. For additional information, refer to the [style guide](../content-style-guide.md). - [ ] Use examples that are generic and can be understood by most people. - [ ] Avoid controversial examples or culturally specific to a group.