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.

Sign up for GitHub

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

Jump to bottom

New React Docs Translation Progress #280

Open
galnir opened this issue Aug 7, 2022 · 30 comments
Open

New React Docs Translation Progress #280

galnir opened this issue Aug 7, 2022 · 30 comments

Comments

@galnir
Copy link
Collaborator

galnir commented Aug 7, 2022 •
edited by galtalmor
Loading

Maintainer List

For New Translators

To translate a page:

  1. Check that no one else has claimed your page in the checklist and comments below.
  2. Comment below with the name of the page you would like to translate. Please take only one page at a time.
  3. Clone this repo, translate your page, and submit a pull request!

Before contributing, read the glossary and style guide (once they exist) to understand how to translate various technical and React-specific terms.

Please be prompt with your translations! If you find that you can't commit anymore, let the maintainers know so they can assign the page to someone else.

For Maintainers

When someone volunteers, edit this issue with the username of the volunteer, and with the PR. Ex:

When PRs are merged, make sure to mark that page as completed!

Main Content

To do before releasing as an "official" translation. Please translate these pages first.

Note that each section has an index page, which needs to be translated too.

Learn React

  • Quick Start

    • Tutorial: Tic Tac Toe
    • Thinking in React

  • Installation

  • Describing the UI

    • Your First Component
    • Importing and Exporting Components
    • Writing Markup with JSX
    • JavaScript in JSX with Curly Braces
    • Passing Props to a Component
    • Conditional Rendering
    • Rendering Lists
    • Keeping Components Pure

  • Adding Interactivity

    • Responding to Events
    • State: A Component's Memory
    • Render and Commit
    • State as a Snapshot
    • Queueing a Series of State Updates
    • Updating Objects in State
    • Updating Arrays in State

  • Managing State

    • Reacting to Input with State
    • Choosing the State Structure
    • Sharing State Between Components
    • Preserving and Resetting State
    • Extracting State Logic into a Reducer
    • Passing Data Deeply with Context
    • Scaling Up with Reducer and Context

  • Escape Hatches

    • Referencing Values with Refs
    • Manipulating the DOM with Refs
    • Synchronizing with Effects
    • You Might Not Need an Effect
    • Lifecycle of Reactive Effects
    • Separating Events from Effects
    • Removing Effect Dependencies
    • Reusing Logic with Custom Hooks

API Reference

  • react: Hooks

    • useCallback (@lidoravitan)
    • useContext (@AvielBitton)
    • useDebugValue
    • useDeferredValue
    • useEffect
    • useId
    • useImperativeHandle
    • useInsertionEffect
    • useLayoutEffect
    • useMemo
    • useReducer
    • useRef
    • useState
    • useSyncExternalStore
    • useTransition

  • react: Components

    • <Fragment> (<>)
    • <Profiler>
    • <StrictMode>
    • <Suspense>

  • react: APIs

    • createContext
    • forwardRef
    • lazy
    • memo
    • startTransition

  • react-dom: Components

    • Common (e.g. <div>)
    • <input>
    • <option>
    • <progress>
    • <select>
    • <textarea>

  • react-dom: APIs

    • createPortal
    • flushSync
    • findDOMNode
    • hydrate
    • render
    • unmountComponentAtNode

  • react-dom/client: Client APIs

    • createRoot
    • hydrateRoot

  • react-dom/server: Server APIs

    • renderToNodeStream
    • renderToPipeableStream
    • renderToReadableStream
    • renderToStaticMarkup
    • renderToStaticNodeStream
    • renderToString

Navigation and UI

We suggest to leave most of the UI translation until the end. We plan to do some invasive changes to the website folder layout and components, so postponing this until your translation is almost complete would make it easier to merge the changes from our side later. It might make sense to translate the homepage above the fold early, but leave the rest for later. As individual pages get translated, you can change the page titles in the corresponding sidebar files. Finally, when you're translating the navigation, make sure to test both desktop and mobile layouts.

  • Homepage (currently in HomeContent.js)
  • Sidebars (currently in src/sidebar*.json)
  • Top-level navigation (currently in TopNav.tsx)

When You're Ready...

After everything above is translated, add your language to deployedLanguages in Seo.tsx of the original reactjs/react.dev repository.

Secondary Content

These API pages should ideally be translated too, but they're less urgent and can be done after the others:

  • Legacy React APIs
    • Children
    • cloneElement
    • Component
    • createElement
    • createFactory
    • createRef
    • isValidElement
    • PureComponent

Optional Content

These aren't the main translation targets, but if you'd like to do them, feel free to expand the list to include their subpages:

  • Community
  • Blog
  • Warnings
@navesadeh
Copy link

I can translate ״Escape Hatches״

@galnir
Copy link
Collaborator Author

galnir commented Sep 27, 2022 •
edited
Loading

I can translate ״Escape Hatches״

edit: actually the first 2 pages are okay, would you like to translate "Referencing Values with Refs" or "Manipulating the DOM with Refs" at this time?

@navesadeh
Copy link

navesadeh commented Sep 27, 2022 via email

@galnir
Copy link
Collaborator Author

galnir commented Sep 27, 2022

I have no problem translating something else as well, whatever is needed

Okay so I'm assigning "Your First Component" to you. This is the page, and this is the file

@hannanel100
Copy link
Contributor

i can help with translation, you can assign me to whatever is needed...

@galnir galnir mentioned this issue Sep 28, 2022
Closed
88 tasks
@galnir
Copy link
Collaborator Author

galnir commented Sep 28, 2022

i can help with translation, you can assign me to whatever is needed...

Awesome, I'm assigning "Importing and Exporting Components" to you.
page
file

@AlonKz1
Copy link

AlonKz1 commented Sep 30, 2022

I can help with translation,
Assign me to whatever is needed .

@galnir
Copy link
Collaborator Author

galnir commented Sep 30, 2022

I can help with translation,
Assign me to whatever is needed .

Thanks! "Writing Markup with JSX" is yours
page
file

@LeviEyal
Copy link

LeviEyal commented Oct 6, 2022

I can translate:
"Reusing Logic with Custom Hooks"
And other pages if needed.

@galnir
Copy link
Collaborator Author

galnir commented Oct 6, 2022 •
edited
Loading

@LeviEyal Can you first translate "JavaScript in JSX with Curly Braces"?

page
file

@AlonKz1
Copy link

AlonKz1 commented Oct 11, 2022 via email

@galnir
Copy link
Collaborator Author

galnir commented Oct 11, 2022

היי ניר, אני פעם ראשונה תורם קודם ואשמח לעזרה. עשיתי FORK לפרויקט וניסיתי להבין לאן אני מתרגם את הדף שביקשתם ולא הבנתי לאן. אשמח לכיוון\עזרה בנושא. תודה מראש ניר וערב נהדר! ‫בתאריך יום ו׳, 30 בספט׳ 2022 ב-13:22 מאת ‪Nir‬‏ @.*** ‬‏>:‬
…

Fork the project, then you have 2 options:

  1. Open the fork repo on your browser, create a new branch for your contribution, go to the file of the page you want to translate, hit 'edit' on the top right bar. Now you can translate on the web browser. You can also open a word document and translate there, then copy to the browser.
  2. Clone the repo to your PC, create a new branch using Git on your terminal and then translate the file in your code editor

אם עדיין לא מובן תעדכן אותי

@AlonKz1
Copy link

AlonKz1 commented Oct 11, 2022 via email

@hannanel100 hannanel100 mentioned this issue Oct 23, 2022
Closed
@gaearon
Copy link
Member

gaearon commented Apr 24, 2023

Hi folks,

Just a heads-up that we've done our best to bring main and legacy branches up-to-date with upstream. This brings you to the latest visual design and sets up all the redirects. We don't anticipate more changes necessary on legacy. For main, there's a few things you need to be aware of:

  • Keep in mind translating UI is best done closer to the end. We plan to make non-trivial code changes to the repo over the next few months. So it's best to focus on the content rather than on UI components.
  • The homepage is untranslated so ideally it would be good if you could do a pass at that. For now, unfortunately it requires messing with the code file.
  • A few rewritten pages (from Installation) are currently untranslated.

Thank you so much for your cooperation!

@gaearon gaearon changed the title Beta React Docs Translation Progress New React Docs Translation Progress Apr 25, 2023
@gaearon
Copy link
Member

gaearon commented Apr 25, 2023

I've updated the translation page checklist.

@gaearon gaearon pinned this issue Apr 25, 2023
@gaearon
Copy link
Member

gaearon commented Apr 25, 2023

@galnir @galtalmor @itayyehezkel @bentlusty

Can you please confirm whether you'd be able to steer and maintain this translation? I want to get the list in https://github.com/reactjs/translations.react.dev/blob/main/langs/he.json updated to match the currently active list. Thank you!

@galtalmor
Copy link
Collaborator

Yep, still active

@galnir
Copy link
Collaborator Author

galnir commented Apr 26, 2023

I'm also active

@itayyehezkel
Copy link
Collaborator

Me too :)

@Yaronglp
Copy link

Yaronglp commented May 7, 2023

Hello,
I would be happy to contribute to useLayoutEffect section.

@lidoravitan
Copy link

Hi, I'd like to start with useCallback, anyone else working on this?

@AvielBitton
Copy link

Hi :)
I will be delighted to contribute to the useContext section.

@lidoravitan
Copy link

@gaearon Who is responsible for managing this project? We are eager to drive its progress. Additionally, Hebrew is an RTL language, so we are curious if there is RTL support available in other projects (i.e Arabic, Hebrew, Persian, Urdu, Kashmiri, Pashto, Uighur, Sorani Kurdish, Punjabi, and Sindhi)

@Yaronglp
Copy link

Do we support dir="rtl" attribute to make the documentation readable?

@galnir
Copy link
Collaborator Author

galnir commented May 17, 2023

I'm still here just didn't have the time to review your PRs. I'll see if I can find how we supported RTL in the old version of the docs

@galtalmor
Copy link
Collaborator

It is mentioned in the thread description that there's still work being done in the main project on the UI and the recommendation was We suggest to leave most of the UI translation until the end.. To me this means we should focus on translating first and only once most content is translated start focusing on the UI and RTL improvements.

@Sa-ar
Copy link

Sa-ar commented May 22, 2023

Hi, I would like to help with the translation.
You can assign me to whatever is needed.

@galtalmor
Copy link
Collaborator

@Sa-ar please choose any of the unassigned pages (ones that do not have a user name in parenthesis next to them), go ahead and start translating and submit an MR once ready. Thanks!

@Yaronglp
Copy link

Yaronglp commented Jul 24, 2023 •
edited
Loading

Hi @galtalmor,

Would it be possible to take off my name from the useLayoutEffect section? The repository appears to be relatively inactive (I'm waiting with PR for almost 4 months ).
Thank you for your understanding :)

@galnir galnir mentioned this issue Sep 27, 2023
Open
@YehudaMenahem
Copy link

Hi,
@galtalmor
@itayyehezkel
@galnir

Is it still relevant to offer a translation?
I can see that a lot of the pages are still available
but no activity for a long time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests