Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs/french] Translate official document to French #377

Merged
merged 15 commits into from
Apr 18, 2021
Merged

[docs/french] Translate official document to French #377

merged 15 commits into from
Apr 18, 2021

Conversation

fguitton
Copy link

@fguitton fguitton commented Jun 22, 2020

  • docs
    • Introduction
      • Motivation
      • Core Concepts
      • Installation
      • Getting Started
    • Basic Tutorial
      • Intro
      • Atoms
      • Selectors
      • Bonus: Performance (Didn't release)
    • Guides
      • Asynchronous Data Queries
      • State Persistence
    • API Reference
      • Core
        • atom()
        • selector()
        • isRecoilValue()
      • Hooks
        • useRecoilState()
        • useRecoilValue()
        • useSetRecoilState()()
        • useResetRecoilState()()
        • useRecoilValueLoadable()()
        • useRecoilStateLoadable()()
        • useRecoilCallback()()
      • Utils
        • atomFamily()
        • selectorFamily()
        • constSelector()
        • errorSelector()
        • noWait()
        • waitForAll()
        • waitForAny()
        • waitForNone()

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 22, 2020
@drarmstr drarmstr added the documentation Improvements or additions to documentation label Jun 22, 2020
@drarmstr
Copy link
Contributor

@fguitton - This PR is currently a "draft," what's your plan for wanting to merge?

@fguitton
Copy link
Author

@drarmstr I'm going to proceed with translating what's left to translate in the coming few days, once that's done I'll be marking this ready for review.

@fguitton
Copy link
Author

@drarmstr I believe I have completed the first treatment of the documentation including the latest changes from the docs branch. There might be the need to pass over this again with a refreshed eye but all of the topics have been translated to french.

@fguitton fguitton marked this pull request as ready for review February 12, 2021 22:00
@drarmstr
Copy link
Contributor

@fguitton - To merge these translations and actually get them published seems like we need to add links to the translations somewhere. @Mark-Yoo was looking at that for the Korean translations in #892, but I'm not sure if he came to a solution yet if you'd like to help?

@fguitton
Copy link
Author

fguitton commented Apr 2, 2021

@drarmstr, @Mark-Yoo, I have worked in the last commit (31076a5) on making things compile with the french Markdown.
You will see that running docusaurus build now builds for both language and produces a build folder containing everything (See below).

I realise now that the other pages will probably have to be dealt with differently, probably relying on the <Translate /> component and the JSON language files.

What are your thoughts ?

image

@drarmstr
Copy link
Contributor

drarmstr commented Apr 3, 2021

@fguitton - Oh, this looks promising! looks like a single yarn build will build for all languages. Can you clarify if this solves how the end user would access the translations?

@fguitton
Copy link
Author

fguitton commented Apr 3, 2021

@drarmstr That's correct, everything gets built with a single yarn build command. I then served everything with serve .\build\ to test everything worked appropriately. Although, in development mode (when using yarn start) one must apparently select which locale they want Docusaurus to serve, like so: yarn start -- --locale fr (Defaults to existing en otherwise).

Regarding what it will be for users, I am directly making use of the built-in locale selector :
There is a couple of different positions to chose from, I found https://reactjs.org and https://docusaurus.io had their own locale menu in the top right so I went for the same.

{
type: 'localeDropdown',
position: 'right',
}

And this yields the following screen:
image

(I also noticed the latter had historical version documentation as well, something Recoil could leverage later ?)

@drarmstr
Copy link
Contributor

Excellent @fguitton, this looks exactly like what we need! I'm catching up now after getting back to work. Is everything here look good for merging the PR now? Could we then merge #892 right after this?

@Mark-Yoo
Copy link

@drarmstr All Korean translations are merged into #18 instead of #892. so you can merge #18, not #892.
#892 will be closed after the #18 is merged :)

@drarmstr
Copy link
Contributor

@drarmstr All Korean translations are merged into #18 instead of #892. so you can merge #18, not #892.
#892 will be closed after the #18 is merged :)

Great, thanks! Ok, then I'll merge this and then #18 after getting the go-ahead from @fguitton .

@alstn2468
Copy link

alstn2468 commented Apr 14, 2021

@fguitton How can we pass translation data in the index.js and resources.js in the pages folder?

@fguitton
Copy link
Author

@drarmstr, Yes, this is fully ready now It's a green light for me. I took the liberty to add the extra commit to translate the home (index.js) and resources (resources.js) pages as well. Giving us something like below. @alstn2468, you can see how I've gotten that done via the <Translate /> API on commit ee54104

image

alstn2468 added a commit to alstn2468/Recoil that referenced this pull request Apr 15, 2021
@drarmstr drarmstr merged commit bf08b76 into facebookexperimental:docs Apr 18, 2021
@drarmstr
Copy link
Contributor

@fguitton - The French translation is now live! Merci!

drarmstr pushed a commit that referenced this pull request Apr 19, 2021
* Create installation_kr.md and translated installation_kr to Korean

* Seperate korean translation folder (docs/docs_kr)

* Translate introduction/gettsing-started.mdx to Korean

* Fix miss typo at docs/krgetting-started.mdx

* Fix missing [] at getting-started.mdx -> CRA

* Translate docs_kr/basic_tutorial/intro.md to Korean

* Translate docs_kr/basic_tutorial/atoms.mdx

* Remove english line at atoms.mdx

* Remove english line at atoms.mdx

* Fix miss typo at atoms.mdx

* Fix miss typo at  installation.d & gettig-started.mdx

* Translate docs_kr/basic_tutorial/selectors.md

* Fix miss typo at basic-tutorial/performance.md line 60

* Translate performace.md to Korean

* Translate core-concepts to Korean

* Fix core-concepts

* Apply lately document from docs to docs_kr

* Fix miss typo at docs_kr - performance section

* [docs/kr] Translate introduction/motivation.md

* Add installation ESLint docs korean verstion

* Translate installation code block comment to Korean

* Apply recent changes at selectors.md

* Apply recent changes at installation.md

* Translate api-reference/core/RecoilRoot.md

* Translate sub title at RecoilRoot

* Translate api-reference/core/atom

* Translate api-reference/core/selector

* Translate api-reference/core/isRecoilValue

* Sync upstream docs to docs_kr

* Sync installation.md

* Sync atomFamily.md

* Sync atom, guides and translate additional atom.md

* Sync asynchronous-data-queries, testing, core-concepts

* Fix typo in intro & performance

* Init docusaurus i18n config

* Fix locale kr -> ko

* Translated: Snapshot.md is now translated into Korean

* Translated: useGotoRecoilSnapshot.md is now translated into Korean

* Translated: Lodable.md is now translated into Korean

* Translated: useRecoilCallback.md is now translated into Korean

* Translated: useRecoilSnapshot.md  is now translated into Korean

* Translated: useRecoilState.md is now translated into Korean

* Translated: useRecoilStateLoadable.md is now translated into Korean

* Translated: useRecoilTransactionObserver.md is now translated into Korean

* Translated: useRecoilValue.md is now translated into Korean

* Translated: useRecoilValueLoadable.md is now translated into Korean

* Translated: useResetRecoilState.md is now translated into Korean

* Translated: useSetRecoilState.md is now translated into Korean

* Translated: asynchronous-data-queries.md is now translated into Korean

* Translated: atom-effects.md is now translated into Korean

* Translated: dev-tools.md  is now translated into Korean

* Translated: testing.md is now translated into Korean

* Sync docs

* Add useGetRecoilValueInfo.md to ko/api-reference/core

* Translated: noWait.md is now translated into korean

* Translated: waitForAny.md is now translated into korean

* Translated: waitForAll.md is now translated into korean

* Translated: waitForNone.md is now translated into korean

* Translated: errorSelector.md is now translated into korean

* Translated: constSelector.md is now translated into korean

* Translated: selectorFamily.md is now translated into korean

* Translated: useRecoilBridgeAcrossReactRoots.md is now translated into korean

* Translated: atomFamily.md is now translated into korean

* Add code.json korean translation

* Add footer.json korean translation

* Add navbar korean translation, fix core concepts title

* Add remaining Korean translation data

* Update docs/i18n/ko/code.json

Co-authored-by: Asher Hwang <dev@hsh.kr>

* Fix typo (시그니쳐 -> 시그니처)

* Init index, resources page translation follow #377(ee54104)

* index.js, resources 페이지 관련 번역 추가

Co-authored-by: Sungwoo Park <codest99@gmail.com>
Co-authored-by: Mark Yoo <yjinhyuk@gmail.com>
Co-authored-by: jung-han <hanjung@nhnent.com>
Co-authored-by: Asher Hwang <dev@hsh.kr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants