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

Use this repo as a base for the official Chinese React docs #334

Open
tesseralis opened this issue Jan 30, 2019 · 17 comments
Open

Use this repo as a base for the official Chinese React docs #334

tesseralis opened this issue Jan 30, 2019 · 17 comments
Labels

Comments

@tesseralis
Copy link

Hi! I'm working on the official translations for the React docs and @gaearon and I are impressed with the quality of this repo. We're actually thinking of doing this approach more generally (see: reactjs/react.dev#1605) and we'd like to use your repo as a starting point. Would you like to work with us into making this the official Chinese React documentation?

@tesseralis tesseralis changed the title Making this the official Chinese React docs Making this repo the official Chinese React docs Jan 30, 2019
@discountry
Copy link
Owner

That sounds great, how should we proceed?

@tesseralis
Copy link
Author

Thanks for replying!

For now, I can think of two things:

  • Sync this fork with the original repository (reactjs/reactjs.org), making sure that logic and formatting are consistent (I can help with this).
  • Ensure that the following sections are translated and up-to-date with the current React docs:
    • Home page
    • Tutorial
    • Main Concepts
    • API

There are other issues (in particular, making sure that anchor names for headings are consistent, but those can wait until changes to the main reactjs.org repository.

Again, thank you so much for the help!

@gaearon
Copy link

gaearon commented Jan 30, 2019

I was thinking that maybe it would be a good idea to start a fresh fork from current English master, and apply translations on top on a file-by-file basis (while checking that they match the content). If some pages have changed significantly, leave them in English so we can come back to them in another pass.

@tesseralis tesseralis changed the title Making this repo the official Chinese React docs Use this repo as a base for the official Chinese React docs Jan 31, 2019
@tesseralis
Copy link
Author

As @gaearon mentioned, I think we'd rather start with a new fork instead (Dan already set one up at https://github.com/reactjs/cn.reactjs.org).

Doing this has the advantage of:

  • Allowing us to cherry-pick commits to make sure everything is up to date.
  • Making sure we don't lose recent website changes.
  • Making sure that translations don't "roll back", i.e. we don't replace "Hello World" with a translated version of it from two years ago.

@lcxfs1991
Copy link

@gaearon @tesseralis

Hi I am Lee from Tencent. A few friends and I had a side project docschina to help localize tech docs. We have run our docs translation team for two years. We have help webpack, rollup, parcel to build their Chinese docs. From our experience, it is hard to keep the docs up to date and it is sometimes hard for Chinese developers to reach the site because github and github pages are usually not stable in China.

My suggestion is that we can use part of the translation content from this repo and start a new one.
We have created one: https://github.com/docschina/cn.reactjs.org. Then we should also deploy a localized copy purely for Chinese developers like webpack, rollup and etc.

@lcxfs1991
Copy link

@gaearon @tesseralis

We have this Chinese official docs for a long time.

https://react.docschina.org/

@discountry
Copy link
Owner

discountry commented Jan 31, 2019

The problem is that our contributors have synced the content between this repo and the official one manually, but the rest files maybe out-dated. And there are also hard-coded content in the src website templates.

I think we should start with the newest official repo, and try to diff the contents file by file.

As @lcxfs1991 mentioned, we've set up a Chinese version doc site for a long time, maybe we can just resolve the cn.reactjs.org domain to it and work with the updates at the same time.

@gaearon
Copy link

gaearon commented Jan 31, 2019

I don’t understand which parts of the proposal you’d like to do differently. Can you explain in more detail?

We thought it would make most sense to:

  • Keep the fork in ReactJS GitHub org
  • You would be owners of that fork
  • You would move content from this repo into that fork page by page, verifying it’s up-to-date
  • We would set up a bot that would help you stay up to date by sending PRs and issues
  • There could still be another mirror site for network connectivity with China

Which parts do you disagree with? We could do it differently. But I’m not sure I understand what it is that you propose to change. Thanks!

@gaearon
Copy link

gaearon commented Jan 31, 2019

I don’t mind making a repository in another org (e.g. docschina) the official one instead of one in our org (reactjs). Can you explain why this is better?

My concerns are:

  • I want website source to match our latest master
  • I want to make sure translated docs match current content and aren’t old

I thought it would be easier to enforce if we move everything into our repo page by page. You will have full control over the repo itself.

But if you want to keep it in docschina org that’s also fine. Please let me know what works better for you.

@discountry
Copy link
Owner

@gaearon There is no disagreement.

We can collaborate under https://github.com/reactjs/cn.reactjs.org.

The bot and auto-sync with official doc would also be helpful.

We'll try to merge the content of this repo to the newest version.

And we already have our translator team, once we got the authority it would be helpful for us to add people to collaborate.

@gaearon
Copy link

gaearon commented Jan 31, 2019

Amazing. If there’s anything we can help you with, let us know!

@gaearon
Copy link

gaearon commented Jan 31, 2019

@discountry Who should I add to the team?

@gaearon
Copy link

gaearon commented Jan 31, 2019

Looks like work started in reactjs/zh-hans.react.dev#3

@QC-L
Copy link
Collaborator

QC-L commented Jan 31, 2019

@gaearon Yeah, Please add @discountry , @lcxfs1991 , @hijiangtao and @dear-lizhihua. THX!

@QC-L QC-L closed this as completed Jan 31, 2019
@discountry discountry added Closed and removed Backlog labels Jan 31, 2019
@QC-L QC-L reopened this Jan 31, 2019
@discountry discountry added Backlog and removed Closed labels Jan 31, 2019
@QC-L
Copy link
Collaborator

QC-L commented Jan 31, 2019

@gaearon Oh, I think the issue of organizing people should be controlled by us. There shouldn’t be too many people, otherwise it will be inconvenient.THX!

@gaearon
Copy link

gaearon commented Jan 31, 2019

I have sent the invitations, you should have access now after you accept them.

@QC-L
Copy link
Collaborator

QC-L commented Jan 31, 2019

@gaearon Oh, that’s great. THX!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants