eggjs/egg

English translation

popomore opened this issue Β· 47 comments

popomore commented

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

List of Document

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

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

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

mattma commented

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

popomore commented

Thx @davidnotes for translatingγ€ŒWhat is egg 」#462

  • πŸ‘2
davidnotes commented

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 .

  • πŸ‘1
popomore commented

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

lslxdx commented
  • πŸ‘2
popomore commented

@lslxdx marked for you

DanielWLam commented

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

  • πŸ‘3
Hiufan commented

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

  • πŸ‘3
Deleted user commented

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

  • πŸ‘3
popomore commented

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

popomore commented

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

popomore commented

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

Brian175 commented

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

popomore commented

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

lslxdx commented

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 commented

@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 commented

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

lslxdx commented

@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 commented

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

cc @Brian175

popomore commented

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

@DanielWLam OK

popomore commented

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

Brian175 commented

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

popomore commented

@Brian175 you can see "How to translate" above

Brian175 commented

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

  • πŸ˜„1
fengmk2 commented

@DarrenWong Great jobs!

DarrenWong commented

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

  • πŸŽ‰1
gztchan commented

Could you assign following parts to me?

  • Logger: /core/logger.md
  • Error Handling: /core/error-handling.md
  • πŸ˜„2
  • πŸŽ‰1
zhang-z commented

Volunteer to /core/cookie-and-session.md
WIP PR: #1562

  • πŸ‘2
Azard commented

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 commented

@Azard It's yours now.

lslxdx commented

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

atian25 commented

@lslxdx done.

zhang-z commented

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

lslxdx commented

@popomore

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

#1594

lslxdx commented

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

lslxdx commented

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

hotNoder commented

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

cemremengu commented

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

  • πŸ‘1
cemremengu commented

@popomore Done ? πŸ‘€

  • πŸ‘1
popomore commented

This issue can be closed, thanks to

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

  • πŸŽ‰1