Skip to content

Commit

Permalink
docs(contributing): update docs with info about translations being on…
Browse files Browse the repository at this point in the history
… hold (#31883) (#32328)

* Docs | Update Community.md and contributing/translation with info about translations being on hold

* fix: typo

Co-authored-by: Megan Sullivan <[email protected]>
  • Loading branch information
weronikadominiak and meganesu authored Jul 12, 2021
1 parent 48571ef commit 9799723
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/contributing/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The Gatsby community welcomes contributions. Please refer to the guides below on
- [How to Open a Pull Request](/contributing/how-to-open-a-pull-request/)
- [Make feature requests with an RFC](/blog/2018-04-06-introducing-gatsby-rfc-process/)
- [Gatsby Style Guide](/contributing/gatsby-style-guide/)
- [Gatsby Translations](/contributing/gatsby-docs-translation-guide/)
- [Gatsby Translations - currently on hold](/contributing/translation/)

## Gatsby news

Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/translation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Translating the Gatsby Documentation

import LangList from "@components/lang-list"

> ⚠️ Note: At the moment our localization efforts are on pause, as we shifted towards a [redesign of the docs](https://www.gatsbyjs.com/blog/announcing-new-gatsby-docs-site/). Right now, we're prioritizing a new version of the tutorial. As with all prioritization efforts, we will weigh this, amongst other potential features, fixes, and improvements, and may consider picking up on the internationalization efforts of 2020. The repositories inside the GitHub org will remain. For now we archived the respective language channels on our Discord and the role for language maintainers.
There is an ongoing effort to translate the content in the Gatsby docs into multiple languages. For members of the community around the world building Gatsby sites and learning about web development, having docs and learning materials in your own language provides a lot of value. There's also a great opportunity for folks like you to contribute to the translations of the Gatsby docs.

If you're a fluent speaker of a language other than English and you're interested in helping translate [gatsbyjs.com](https://gatsbyjs.com), here is some information for you to know:
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/translation/maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Translation Maintainer Guide
---

> ⚠️ Note: At the moment our localization efforts are on pause, as we shifted towards a [redesign of the docs](https://www.gatsbyjs.com/blog/announcing-new-gatsby-docs-site/). Right now, we're prioritizing a new version of the tutorial. As with all prioritization efforts, we will weigh this, amongst other potential features, fixes, and improvements, and may consider picking up on the internationalization efforts of 2020. The repositories inside the GitHub org will remain. For now we archived the respective language channels on our Discord and the role for language maintainers.
This page lists the responsibilities of translation maintainers and provides tips on how to better manage your repository.

## Maintainer responsibilities
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/translation/new-translations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Starting a New Translation
---

> ⚠️ Note: At the moment our localization efforts are on pause, as we shifted towards a [redesign of the docs](https://www.gatsbyjs.com/blog/announcing-new-gatsby-docs-site/). Right now, we're prioritizing a new version of the tutorial. As with all prioritization efforts, we will weigh this, amongst other potential features, fixes, and improvements, and may consider picking up on the internationalization efforts of 2020. The repositories inside the GitHub org will remain. For now we archived the respective language channels on our Discord and the role for language maintainers.
This page lists the steps to take to create a new Gatsby docs translation.

## Creating a translation
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/translation/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Translation Style Guide
---

> ⚠️ Note: At the moment our localization efforts are on pause, as we shifted towards a [redesign of the docs](https://www.gatsbyjs.com/blog/announcing-new-gatsby-docs-site/). Right now, we're prioritizing a new version of the tutorial. As with all prioritization efforts, we will weigh this, amongst other potential features, fixes, and improvements, and may consider picking up on the internationalization efforts of 2020. The repositories inside the GitHub org will remain. For now we archived the respective language channels on our Discord and the role for language maintainers.
Each language translation may have some specific ways it differs from the advice Gatsby provides for writing in English, such as the use of "you" as the pronoun or the Oxford comma. Each translation group should decide on conventions and stick with them for consistency, documenting those decisions in the repo's [style guide](https://github.com/gatsbyjs/gatsby-i18n-source/blob/master/style-guide.md) file to set contributors up for success. Use the [English style guide](/contributing/gatsby-style-guide/) as a reference to determine the equivalent rules in your language.

Guidelines that remain firm no matter the language stem from the goals and values of Gatsby as a project: to provide a **friendly community for Gatsby learners of all skill and experience levels** that's also **safe and welcoming to contributors**. Translated docs and learning materials should [maintain these values](/blog/2019-04-19-gatsby-why-we-write/) with **high-quality spelling and grammar**, accurate information, similar structure and purpose. For any questions about guidelines, feel free to [get in touch](/contributing/how-to-contribute/#not-sure-how-to-start-contributing) with the Gatsby team.
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/translation/sync-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Keeping Translations Up-to-date
---

> ⚠️ Note: At the moment our localization efforts are on pause, as we shifted towards a [redesign of the docs](https://www.gatsbyjs.com/blog/announcing-new-gatsby-docs-site/). Right now, we're prioritizing a new version of the tutorial. As with all prioritization efforts, we will weigh this, amongst other potential features, fixes, and improvements, and may consider picking up on the internationalization efforts of 2020. The repositories inside the GitHub org will remain. For now we archived the respective language channels on our Discord and the role for language maintainers.
Every Friday at 6:00 PM PST, gatsbybot will run a sync script on every translation repo to bring them up-to-date with the current English repo. If there is an update to a page that is already translated, gatsbybot will create a pull request listing the conflicts between the translation and the new English content. Resolving these conflicts and merging these pull requests is essential to keeping your translation repo up-to-date.

## Gatsbybot sync behavior
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/translation/translators.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Contributing to a Translation
---

> ⚠️ Note: At the moment our localization efforts are on pause, as we shifted towards a [redesign of the docs](https://www.gatsbyjs.com/blog/announcing-new-gatsby-docs-site/). Right now, we're prioritizing a new version of the tutorial. As with all prioritization efforts, we will weigh this, amongst other potential features, fixes, and improvements, and may consider picking up on the internationalization efforts of 2020. The repositories inside the GitHub org will remain. For now we archived the respective language channels on our Discord and the role for language maintainers.
Once a language repository is created and someone on the Gatsby team has assigned codeowners, contributions can begin. It is up to the discretion of the contributor how exactly they want to work, but it's recommended to limit the scope of PRs to 1 doc at a time to aid with code reviewing.

> ⚠️ Note: All contributors are expected to follow the [Gatsby Code of Conduct](/contributing/code-of-conduct/) and work professionally with fellow contributors. For issues with conduct, if you are unable to work things out amicably amongst yourselves (perhaps after filing a public issue or having a discussion on Discord), you can contact the Gatsby team at [[email protected]](mailto:[email protected]) with details about the situation.
Expand Down

0 comments on commit 9799723

Please sign in to comment.