docs(middleware.md): translated & proofread 'middleware.md' #784

lslxdx · 2017-04-20T10:58:14Z

'middleware.md' is translated by @lslxdx and proofread by @闷油瓶小张

related issue: #783

Checklist

documentation is changed or added

Affected core subsystem(s)

Description of change

close #783

@lslxdx

'middleware.md' is translated by @lslxdx and proofread by @闷油瓶小张 related issue: eggjs#783

codecov · 2017-04-20T11:13:16Z

Codecov Report

Merging #784 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #784   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          28     28           
  Lines         667    667           
=====================================
  Hits          667    667

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e55a134...330d0cb. Read the comment docs.

popomore · 2017-04-20T13:23:16Z

docs/source/en/basics/middleware.md

+
+## Writing Middleware
+
+### how to write


capitalize how

Done. commit: fefcbdb

popomore · 2017-04-20T13:24:36Z

docs/source/en/basics/middleware.md

+
+### how to write
+
+We begin by writing a simple gzip middleware, to see how to write middleware


We begin to see how to write a middleware from a simple gzip example

Done. commit: fefcbdb

popomore · 2017-04-20T13:29:23Z

docs/source/en/basics/middleware.md

+
+### Configuration
+
+Usually the middleware has its own configuration. In the framework, a complete middleware is including the configuration process. We agree that a middleware is a separate file placed in `app/middleware` directory, which needs an exports function that take two parameters:


a middleware is a file in app/middleware directory by convention

convention from https://en.wikipedia.org/wiki/Convention_over_configuration

Done. commit: fefcbdb

popomore · 2017-04-20T13:31:53Z

docs/source/en/basics/middleware.md

+## Importing Middleware in the Application
+
+We can import customized middleware completely by configuration in the application, and decide their order.
+If we need to import the gzip Middleware in the above, 


Middleware > middleware

Done. commit: fefcbdb

popomore · 2017-04-20T13:37:26Z

docs/source/en/basics/middleware.md

+  },
+};
+```
+** Note: middleware imported by the framework and plugins are loaded earlier than those imported by the application layer, and the application layer cannot overwrite the default framework middleware. If the application layer imports customized middleware that has the same name with default framework middleware, an error will be raised on starting up. **


better to change layer to middleware

Change 'application layer' to 'application middleware'?

How about changing 'application layer' to 'application'? Does it make sense?

Good!
Anyway, it is not finalized and can be changed at any time though.

Does anyone have other suggestions?

popomore · 2017-04-20T13:38:56Z

docs/source/en/basics/middleware.md

+```
+** Note: middleware imported by the framework and plugins are loaded earlier than those imported by the application layer, and the application layer cannot overwrite the default framework middleware. If the application layer imports customized middleware that has the same name with default framework middleware, an error will be raised on starting up. **
+
+## The Use of Middleware in Router


- The Use of Middleware in Router + Middleware in Router

Done. commit: fefcbdb

popomore · 2017-04-20T13:41:53Z

感觉中文文档可以把引入改为加载，翻译成 import 有点难懂，还是叫 load 比较好。

Related issue: eggjs#784

lslxdx · 2017-04-21T02:00:05Z

@popomore

感觉中文文档可以把引入改为加载，翻译成 import 有点难懂，还是叫 load 比较好。

需要在英文文档中修改过来吗？还是说先改中文文档，再改英文文档？

popomore · 2017-04-21T08:46:38Z

需要在英文文档中修改过来吗？还是说先改中文文档，再改英文文档？

中英文一起改吧，看看其他人的意见 @dead-horse @atian25

atian25 · 2017-04-21T09:18:54Z

都行吧，小的点顺手改也可以，主要还是 focus 翻译上。其他的我们另开 PR 都行。发自我的 iPhone

…

在 2017年4月21日，17:15，lslxdx ***@***.***> 写道： @lslxdx commented on this pull request. In docs/source/en/basics/middleware.md: > +``` + +** About Configuration fields and runtime environment configurations, see [Config](./config.md) chapter. ** + +## Default Framework Middleware + +In addition to the application layer middleware is imported, the framework itself and other plug-ins will also import many middleware. All the config fields of these built-in middlewares can be modified by modifying the ones with the same name in the config file, for example [Framework Built-in Plugin](https://github.com/eggjs/egg/tree/master/app/middleware) uses a bodyParser middleware(the framework loader will change the file name separated by delimiters into the camel style), and we can add configs below in `config/config.default.js` to modify the bodyParser: + +```js +module.exports = { + bodyParser: { + jsonLimit: '10m', + }, +}; +``` +** Note: middleware imported by the framework and plugins are loaded earlier than those imported by the application layer, and the application layer cannot overwrite the default framework middleware. If the application layer imports customized middleware that has the same name with default framework middleware, an error will be raised on starting up. ** Good! Anyway, it is not finalized and can be changed at any time though. Does anyone have other suggestions? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

lslxdx · 2017-04-21T09:29:08Z

@popomore @atian25

可以做3件事情：

创建一个单独的issue, 比如中文文档应该把引入改为加载，因为翻译成 import 有点难懂，还是叫 load 比较好。
在这个doc的翻译版上改成"load"
在这个doc的中文版上改成"加载"

可行吗？哪几件(些)事情可行的？

popomore · 2017-04-21T10:03:45Z

@lslxdx 在这篇文章里面把中英文都改了好了，其他文章遇到翻译不通顺的地方可以选择性修改。

lslxdx · 2017-04-21T10:15:35Z

@popomore 好的，晚上改

将这篇文档中的'引入'更改为'加载', 这样可以更容易理解 issue: eggjs#784

Change 'import' to 'load' for a better understanding. issue: eggjs#784

Change "Loading Middleware in the Application" to "Using Middleware in the Application"

lslxdx · 2017-04-24T02:29:21Z

@popomore IIRC, we discussed the "application layer/middleware" issue days ago(I can't find the discussion URL, sigh), luckily I find a similar expression here just now, for example:

You can load application-level and router-level middleware with an optional mount path.

and

Application-level middleware

So could we use "application-level" as an agreement?

popomore · 2017-04-25T16:35:01Z

When we talk about middleware, we have two steps

First middelwares will be loaded from application, plugin and framework, it can be called application-level middleware. build-in middleware also meam framework-level middleware.
Then I use the middleware which have been loaded, it can be used automatically by configuration whitch is config.appMiddleware and config.coreMiddleware, it also can be used in router manually. That's what express does.

So I agree using xx-level in document of load middleware, but don't use it in use middleware.

lslxdx · 2017-04-26T02:14:18Z

So I agree using xx-level in document of load middleware, but don't use it in use middleware.

Yes, that makes sense and I agree too!

atian25 · 2017-05-03T07:25:28Z

Is there anything still block this pr, guys?

popomore · 2017-05-10T04:07:05Z

@lslxdx can you complete this PR first?

lslxdx · 2017-05-10T05:43:42Z

@popomore I'm stuck on this thread and could you please help me out?

All I can see is:

Review required

At least one approved review is required by reviewers with write access. Learn more.

All checks have passed

5 successful checks

Merging is blocked

Merging can be performed automatically with one approved review.

What should I do next?

popomore · 2017-05-10T05:54:16Z

So I agree using xx-level in document of load middleware, but don't use it in use middleware.

Yes, that makes sense and I agree too!

I think you will update something, maybe I was wrong?

lslxdx · 2017-05-10T05:58:08Z

Aha! Got it and I am on it!

Use 'application-level' instead of 'application layer' in some cases.

lslxdx · 2017-05-10T06:24:20Z

@popomore I make some changes just now and please have a look.

popomore

LGTM

docs(middleware.md): translated & proofread 'middleware.md'

05e2ded

'middleware.md' is translated by @lslxdx and proofread by @闷油瓶小张 related issue: eggjs#783

lslxdx mentioned this pull request Apr 20, 2017

docs(middleware.md): translated & proofread 'middleware.md' #783

Closed

1 task

atian25 requested review from popomore and shaoshuai0102 April 20, 2017 11:07

atian25 added the type: document label Apr 20, 2017

popomore reviewed Apr 20, 2017

View reviewed changes

Update middleware.md

fefcbdb

Related issue: eggjs#784

lslxdx pushed a commit to lslxdx/egg that referenced this pull request Apr 21, 2017

docs(middleware.md): '引入' -> '加载'

cb29103

将这篇文档中的'引入'更改为'加载', 这样可以更容易理解 issue: eggjs#784

docs(middleware.md): 'import' -> 'load'

00e7ce3

Change 'import' to 'load' for a better understanding. issue: eggjs#784

lslxdx mentioned this pull request Apr 21, 2017

docs(middleware.md): '引入' -> '加载' #792

Merged

1 task

lslxdx added 2 commits April 24, 2017 10:08

docs(middleware.md): fix typo

66eec58

Change "Loading Middleware in the Application" to "Using Middleware in the Application"

Merge branch 'master' into trans_middleware_using_github_name

4296242

Merge branch 'master' into trans_middleware_using_github_name

b36cfc1

Merge branch 'master' into trans_middleware_using_github_name

118f1cb

docs(middleware.md): use 'application-level'

330d0cb

Use 'application-level' instead of 'application layer' in some cases.

popomore approved these changes May 10, 2017

View reviewed changes

popomore merged commit 22c9cd9 into eggjs:master May 10, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(middleware.md): translated & proofread 'middleware.md' #784

docs(middleware.md): translated & proofread 'middleware.md' #784

lslxdx commented Apr 20, 2017 •

edited by atian25

Loading

codecov bot commented Apr 20, 2017 •

edited

Loading

popomore Apr 20, 2017

lslxdx Apr 21, 2017

popomore Apr 20, 2017

lslxdx Apr 21, 2017

popomore Apr 20, 2017 •

edited

Loading

lslxdx Apr 21, 2017

popomore Apr 20, 2017

lslxdx Apr 21, 2017

popomore Apr 20, 2017 •

edited

Loading

lslxdx Apr 21, 2017

popomore Apr 21, 2017

lslxdx Apr 21, 2017

popomore Apr 20, 2017

lslxdx Apr 21, 2017

popomore commented Apr 20, 2017

lslxdx commented Apr 21, 2017

popomore commented Apr 21, 2017

atian25 commented Apr 21, 2017 via email

lslxdx commented Apr 21, 2017

popomore commented Apr 21, 2017

lslxdx commented Apr 21, 2017

lslxdx commented Apr 24, 2017

popomore commented Apr 25, 2017

lslxdx commented Apr 26, 2017

atian25 commented May 3, 2017

popomore commented May 10, 2017

lslxdx commented May 10, 2017

popomore commented May 10, 2017

lslxdx commented May 10, 2017

lslxdx commented May 10, 2017

popomore left a comment


		### how to write

		We begin by writing a simple gzip middleware, to see how to write middleware


		### Configuration

		Usually the middleware has its own configuration. In the framework, a complete middleware is including the configuration process. We agree that a middleware is a separate file placed in `app/middleware` directory, which needs an exports function that take two parameters:

docs(middleware.md): translated & proofread 'middleware.md' #784

docs(middleware.md): translated & proofread 'middleware.md' #784

Conversation

lslxdx commented Apr 20, 2017 • edited by atian25 Loading

Checklist

Affected core subsystem(s)

Description of change

codecov bot commented Apr 20, 2017 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popomore Apr 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popomore Apr 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popomore commented Apr 20, 2017

lslxdx commented Apr 21, 2017

popomore commented Apr 21, 2017

atian25 commented Apr 21, 2017 via email

lslxdx commented Apr 21, 2017

popomore commented Apr 21, 2017

lslxdx commented Apr 21, 2017

lslxdx commented Apr 24, 2017

popomore commented Apr 25, 2017

lslxdx commented Apr 26, 2017

atian25 commented May 3, 2017

popomore commented May 10, 2017

lslxdx commented May 10, 2017

Review required

All checks have passed

Merging is blocked

popomore commented May 10, 2017

lslxdx commented May 10, 2017

lslxdx commented May 10, 2017

popomore left a comment

Choose a reason for hiding this comment

lslxdx commented Apr 20, 2017 •

edited by atian25

Loading

codecov bot commented Apr 20, 2017 •

edited

Loading

popomore Apr 20, 2017 •

edited

Loading

popomore Apr 20, 2017 •

edited

Loading