Egg: English translation

[popomore]

We have got some requirement for english document, so we should make some schedule to do it.

List of Document

• [x] Intro:
  
  
  
  • [x] What is egg: /intro/index.md @davidnotes
  
  
  • [x] egg and koa: /intro/egg-and-koa.md @davidnotes
  
  
  • [x] Get Start: /intro/quickstart.md
  
  
  • [ ] migration: /migration.md
  
  
• [x] Basics:
  
  
  
  • [x] Environment: /basics/env.md
  
  
  • [x] Object: /basics/objects.md @Azard
  
  
  • [x] Config: /basics/config.md @jwssdwed @Brian175
  
  
  • [x] Middleware: /basics/middleware.md @lslxdx
  
  
  • [x] Router: /basics/router.md @lslxdx
  
  
  • [x] Controller: /basics/controller.md @lslxdx
  
  
  • [x] Service: /basics/service.md @lslxdx
  
  
  • [x] Plugin: /basics/plugin.md
  
  
  • [x] Schedule: /basics/schedule.md @Azard
  
  
  • [x] Structure: /basics/structure.md @Azard
  
  
  • [x] Extend: /basics/extend.md @DanielWLam
  
  
  • [x] Custom init: /basics/app-start.md @atian25
  
  
• [x] Tutorials:
  
  
  
  • [x] Index: /tutorials/index.md @DarrenWong
  
  
  • [x] MySQL: /tutorials/mysql.md @DarrenWong
  
  
  • [x] RESTful API: /tutorials/restful.md @DarrenWong
  
  
  • [x] Progressive: /tutorials/progressive.md @DarrenWong
  
  
  • [x] Async Function: /tutorials/async-function.md @DarrenWong
  
  
  • [x] Socket.IO: /tutorials/socketio.md
  
  
  • [x] passport: /tutorials/passport.md
  
  
• [x] Core:
  
  
  
  • [x] Cluster and Ipc: /core/cluster-and-ipc.md @lslxdx
  
  
  • [x] Cookie and Session: /core/cookie-and-session.md @zhang-z
  
  
  • [ ] Development: /core/development.md @gztchan
  
  
  • [x] Deployment: /core/deployment.md
  
  
  • [x] Security: /core/security.md @lslxdx
  
  
  • [x] HttpClient: /core/httpclient.md @DarrenWong
  
  
  • [x] Logger: /core/logger.md @gztchan
  
  
  • [x] Error Handling: /core/error-handling.md @gztchan
  
  
  • [x] i18n: /core/i18n.md @DarrenWong
  
  
  • [x] View: /core/view.md @zhang-z
  
  
  • [x] Unit Testing: /core/unittest.md
  
  
• [x] Advanced:
  
  
  
  • [x] Loader: /advanced/loader.md @Azard
  
  
  • [x] Plugin Development: /advanced/plugin.md
  
  
  • [x] Framework: /advanced/framework.md @freebyron
  
  
  • [x] Cluster: /advanced/cluster.md
  
  
  • [x] View Plugin: /advanced/view-plugin.md
  
  
• [x] Community:
  
  
  
  • [x] style guide: /style-guide.html
  
  
  • [x] Resource: /resource.md
  
  
  • [x] Faq: /faq.md
  
  

Where is the document

Now you can see all available English document in https://github.com/eggjs/egg/tree/master/docs/source/en

How to translate

1. If you want to pick one to translate, you can create a PR first. Then I will know it has been taken.
2. Any one can proofread it, and finalized by Egg core member and SwiftGG member.
3. you can update this PR until merged

Contribute

Welcome to join us to translate egg document, We are glad to see that.

[fengmk2]

@mattma 'What is egg' is the important document.

@dead-horse 'egg and koa' write again with your good English.

[mattma]

@fengmk2 I will work on what is egg next. thanks

[popomore]

Thx @davidnotes for translating「What is egg 」https://github.com/eggjs/egg/pull/462

[davidnotes]

Hi all, I have almost finished 'egg and koa' english doc and I will give the pull request tonight. Hope it will help @fengmk2 @dead-horse @popomore .

[popomore]

@davidnotes good work, we will at someone after the document if he picked it.

[popomore]

https://github.com/eggjs/egg/pull/783

[lslxdx]

Hi all,

2 things:

1. the "Router: /basics/router.md" HAS BEEN TRANSLATED by me and waiting to be proofread.
2. the "Controller: /basics/controller.md" IS BEING TRANSLATED(about 50% is done)

[popomore]

@lslxdx marked for you

[DanielWLam]

Hi, I would like to help to tranlate Service: /basics/service.md, thanks @fengmk2

[Hiufan]

Hi, I think I can help to translate this page: Config: /basics/config.md.

[ghost]

Hi, I would like to translate Env: /basics/env.md, thanks.

[popomore]

@DanielWLam @Hiufan @zacks223 Thx, you can do it now, I have added you to the list.

[popomore]

@zacks223 Sorry, env.md has been translated, would you choose another one?

[popomore]

@lslxdx Do you have time to translate the uncomplete document you choose?

[Brian175]

@DanielWLam @Hiufan @zacks223 Hey, guys! Will you have interest in joining our group in the document translation?
https://github.com/SwiftGGFETeam/

[popomore]

Hi @Brian175 , would you like check the document which has been taken in this issue before translating.

[lslxdx]

Hi @DanielWLam, @fengmk2, the basics/service.md has been translated by me days ago.

https://github.com/SwiftGGFETeam/egg/blob/basics.service/docs/source/en/basics/service.md

[lslxdx]

Hi @popomore, the basics/controller.md and basics/middleware.md have been completed.

https://github.com/SwiftGGFETeam/egg/blob/basics.controller/docs/source/en/basics/controller.md

https://github.com/SwiftGGFETeam/egg/blob/basics.middleware/docs/source/en/basics/middleware.md

[lslxdx]

Hi @popomore, the basics/router.md was translated, BUT was not commited in Github. I will commit it tomorrow. Sigh ~

I'm working on basics/schedule.md and finding a new job now...

[DanielWLam]

@Brian175 Sounds good to me. I am in! And since @lslxdx has finished those tasks, maybe i should work on /basics/extend.md @popomore

[popomore]

@lslxdx @Brian175 @DanielWLam Could you create PR first when you are starting translation? All of us will know which one is be taken.

[lslxdx]

@popomore That sounds good to me.

Up to now, my work process is:

1. git clone https://github.com/SwiftGGFETeam/egg;
2. create 1 new branch for each doc and begin to translate it;
3. commit, push and waiting for other guys to proofread and finalize the doc on the branch.
4. After the doc is finalized, the branch is merged to master and a PR to https://github.com/eggjs/egg is created then.

Is it a proper work process?

[popomore]

@lslxdx I think you can do it on egg directly, SwiftGG Team and Egg core member can review it on it.

cc @Brian175

[popomore]

And since @lslxdx has finished those tasks, maybe i should work on /basics/extend.md

@DanielWLam OK

[popomore]

And I have updated the rule for translating, is it suitable for you? @lslxdx @Brian175

[Brian175]

@popomore Can you tell more details? I am a little in confusion.

[popomore]

@Brian175 you can see "How to translate" above

[Brian175]

@popomore I've got it, it's okay.Thanks.

[fengmk2]

@DarrenWong Great jobs!

[DarrenWong]

@fengmk2 thx, I will keep it up and study Egg O(∩_∩)O

[gztchan]

Could you assign following parts to me?

• Logger: /core/logger.md
• Error Handling: /core/error-handling.md

[popomore]

@gztchan Sure

[zhang-z]

Volunteer to /core/cookie-and-session.md
WIP PR: https://github.com/eggjs/egg/pull/1562

[Azard]

Basics/Object should be checked: https://github.com/eggjs/egg/blob/master/docs/source/en/basics/objects.md

And schedule is still be translated by @lslxdx ?
Maybe I can do this.

[popomore]

@Azard It's yours now.

[lslxdx]

Count you please assign Cluster and Ipc: /core/cluster-and-ipc.md to me? Thanks!

[atian25]

@lslxdx done.

[zhang-z]

Volunteer to /core/view.md
WIP PR: #1577

[lslxdx]

@popomore

core/cluster-and-ipc.md translated & please have a check.

https://github.com/eggjs/egg/pull/1594

[lslxdx]

Please assign Security: /core/security.md to me, thanks!

[popomore]

@zhang-z @lslxdx done

[lslxdx]

I notice that Deployment: /core/deployment.md has been translated, could anybody make the List of Document be updated?

[hotNoder]

Hi, @popomore I would like to translate Advanced: Cluster: /advanced/cluster-client.md. Seems like the list should be updated, thanks.

[cemremengu]

Looks like this issue will be closed after the current PRs are merged

[cemremengu]

@popomore Done ? 👀

[popomore]

This issue can be closed, thanks to

• @hotNoder
• @freebyron
• @Azard
• @rccoder
• @cemremengu
• @SunShinewyf
• @lslxdx 
• @zhang-z
• @gztchan
• @DarrenWong
• @freebyron
• @davidnotes

But we have some new document that have not be translated.

• development
• assets
• typescript
• migration

[popomore]

cc @atian25