docs(basics/router.md): [translate] Done #896

lslxdx · 2017-05-11T12:24:09Z

Finish translating 'basics/router.md' and wait for guys to proofread it.

Checklist

documentation is changed or added

Affected core subsystem(s)

Description of change

Finish translating 'basics/router.md' and wait for guys to proofread it.

codecov · 2017-05-11T12:39:25Z

Codecov Report

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

@@          Coverage Diff          @@
##           master   #896   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          28     28           
  Lines         669    669           
=====================================
  Hits          669    669

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 02b02e0...9fd042f. Read the comment docs.

dead-horse · 2017-05-11T15:26:50Z

docs/source/en/basics/router.md

+
+Methods that are not needed may not be implemented in `posts.js` and the related URL paths will not be registered to Router neither.
+
+## destroy in action


https://eggjs.org/zh-cn/basics/router.html#router-实战

change to Router in Action

dead-horse · 2017-05-11T15:27:27Z

docs/source/en/basics/router.md

+
+## destroy in action
+
+The destroy syntax will demonstrated by more examples.


下面通过更多实际的例子，来说明 router 的用法。

dead-horse · 2017-05-11T15:28:26Z

docs/source/en/basics/router.md

+
+> If you perform a POST request directly, an **error** will occur: 'secret is missing'. This error message comes from [koa-csrf/index.js#L69](https://github.com/koajs/csrf/blob/2.5.0/index.js#L69).
+
+> **Reason**: the framework verifies the CSFR value specially for form POST requests, so please submit the CSRF key as well when you submit a form. For more detail refer to [Keep Away from CSRF Threat](https://eggjs.org/zh-cn/core/security.html#å®‰å…¨å¨èƒcsrfçš„é˜²èŒƒ)


LibreOffice的问题. 已改正.

dead-horse · 2017-05-11T15:29:26Z

docs/source/en/basics/router.md

+
+```js
+// app/router.js
+module.exports = app => { require('./router/news')(app);


手误按了J, 已改正.

Brian175 · 2017-05-11T14:23:49Z

docs/source/en/basics/router.md

+
+Router is mainly used to describe the relationship between the request URL and the Controller that processes the request eventually. All routing rules are unified in the `app/router.js` file by the framework.
+
+By unifying routing rules, routing logics are free from scatter, random conflicts disappear and it becomes easy for us to see global routing rules.


'By unifying routing rules, routing logics are free from scatter, random conflicts disappear and ...'
It maybe more proper like this:
By unifying routing rules, routing logics are free from scatter that may cause unkown conflicts and it will be easier for us to check global routing rules.

Brian175 · 2017-05-11T14:43:43Z

docs/source/en/basics/router.md

+  * app.patch - PATCH
+  * app.delete - DELETE
+  * app.del - this is a alias method due to the reservation of delete.
+  * app.redirect - redirect the request URL. For example, the most common case is to redirect the request accessing the root directory to the homepage.


'app.redirect - redirect the request URL'
to redirect the request URL or redirecting the request the URL ?

How about 'redirects the request URL' which means 'app.redirect redirects the request URL'?

@lslxdx Do you need update this one?

@popomore @Brian175 Yes, I've done.

Brian175 · 2017-05-11T14:46:52Z

docs/source/en/basics/router.md

+  * app.delete - DELETE
+  * app.del - this is a alias method due to the reservation of delete.
+  * app.redirect - redirect the request URL. For example, the most common case is to redirect the request accessing the root directory to the homepage.
+- router-name define a alias for the route, and URL can be generated by helper method `pathFor` and `urlFor` provided by Helper. (Optional)


'define a alias for the route'
suggestion:
defines

Brian175 · 2017-05-11T14:47:59Z

docs/source/en/basics/router.md

+  * app.redirect - redirect the request URL. For example, the most common case is to redirect the request accessing the root directory to the homepage.
+- router-name define a alias for the route, and URL can be generated by helper method `pathFor` and `urlFor` provided by Helper. (Optional)
+- path-match - URL path of the route.
+- middleware1 - multiple Middlewares can be configured in Router. (Optional)


'Middleware'

Do you mean 'multiple Middleware'?

Okay, I've done.

Brian175 · 2017-05-11T14:52:59Z

docs/source/en/basics/router.md

+- middleware1 - multiple Middlewares can be configured in Router. (Optional)
+- controller.action - it's a string, take care. The framework will find the Controller sharing the name under `app/controller`, then assign the process to the configured action method. The action can be omitted if the Controller exports a method directly.
+
+### IMPORTANT


'Notices' may be more proper?

Brian175 · 2017-05-11T15:19:11Z

docs/source/en/basics/router.md

+
+> **Reason**: the framework verifies the CSFR value specially for form POST requests, so please submit the CSRF key as well when you submit a form. For more detail refer to [Keep Away from CSRF Threat](https://eggjs.org/zh-cn/core/security.html#å®‰å…¨å¨èƒcsrfçš„é˜²èŒƒ)
+
+> **Note**: the verification is performed because the framework builds in a security plugin [egg-security](https://github.com/eggjs/egg-security) that provides some default security practices and this plugin is enabled by default. In case you want to disable some security protections, just configure the enable attribute of if to be false.


'just configure ...'
suggestion:
'just set the enable attribute to false'

Brian175 · 2017-05-11T15:21:21Z

docs/source/en/basics/router.md

+
+> **Note**: the verification is performed because the framework builds in a security plugin [egg-security](https://github.com/eggjs/egg-security) that provides some default security practices and this plugin is enabled by default. In case you want to disable some security protections, just configure the enable attribute of if to be false.
+
+> "Unless you know the consequence consciously, it's recommended not to disable functions provided by the security plugin"


‘unless ...’
suggestion: 'Unless you clearly confirm ..., it's not recommended ...'

Brian175 · 2017-05-11T15:25:30Z

docs/source/en/basics/router.md

+
+### Using Middleware
+
+A middleware can be used to change the request parameter of one kind of user requests to uppercase.


suggestion:
leave out 'of one kind of user requests'

Agree.

BTW, should we change the doc of Chinese version together?
e.g.:
'把用户某一类请求的参数都大写' => '把用户请求的参数都大写'

Brian175 · 2017-05-11T15:27:40Z

docs/source/en/basics/router.md

+### Using Middleware
+
+A middleware can be used to change the request parameter of one kind of user requests to uppercase.
+Here we show how to use the middleware briefly, referring to [Middleware](./middleware.md) for detail.


suggestion:
'Here we just briefly explain how to use the middleware, refer to ...'

correct.

Moreover, how about '..., and refer to ...'?

Brian175 · 2017-05-11T15:33:31Z

docs/source/en/basics/router.md

+
+### Too Many Routing Maps?
+
+As described above, we do not recommend you scatter routing logics all around, or it leads to a difficult trouble shooting.


'we do not recommend ...'
suggestion:
'we do not recommend that ..., or it will bring trouble in trouble shooting'

popomore · 2017-05-16T06:54:57Z

docs/source/en/basics/router.md

+  * app.patch - PATCH
+  * app.delete - DELETE
+  * app.del - this is a alias method due to the reservation of delete.
+  * app.redirect - redirect the request URL. For example, the most common case is to redirect the request accessing the root directory to the homepage.


@lslxdx Do you need update this one?

docs(basics/router.md): [translate] Done

93ba651

Finish translating 'basics/router.md' and wait for guys to proofread it.

dead-horse reviewed May 11, 2017

View reviewed changes

Brian175 suggested changes May 11, 2017

View reviewed changes

lslxdx added 2 commits May 14, 2017 10:44

Update router.md

d5836da

Merge branch 'master' into basics.router

bc2b9b4

Brian175 approved these changes May 15, 2017

View reviewed changes

Merge branch 'master' into basics.router

6a41616

popomore approved these changes May 16, 2017

View reviewed changes

lslxdx added 3 commits May 17, 2017 09:56

Update router.md

91e0c55

Merge branch 'master' into basics.router

7332f46

Update router.md

9fd042f

popomore merged commit 25c7c95 into eggjs:master May 17, 2017


		Methods that are not needed may not be implemented in `posts.js` and the related URL paths will not be registered to Router neither.

		## destroy in action


		## destroy in action

		The destroy syntax will demonstrated by more examples.


		> If you perform a POST request directly, an error will occur: 'secret is missing'. This error message comes from [koa-csrf/index.js#L69](https://github.com/koajs/csrf/blob/2.5.0/index.js#L69).

		> Reason: the framework verifies the CSFR value specially for form POST requests, so please submit the CSRF key as well when you submit a form. For more detail refer to [Keep Away from CSRF Threat](https://eggjs.org/zh-cn/core/security.html#å®‰å…¨å¨èƒcsrfçš„é˜²èŒƒ)


		Router is mainly used to describe the relationship between the request URL and the Controller that processes the request eventually. All routing rules are unified in the `app/router.js` file by the framework.

		By unifying routing rules, routing logics are free from scatter, random conflicts disappear and it becomes easy for us to see global routing rules.


		> Reason: the framework verifies the CSFR value specially for form POST requests, so please submit the CSRF key as well when you submit a form. For more detail refer to [Keep Away from CSRF Threat](https://eggjs.org/zh-cn/core/security.html#å®‰å…¨å¨èƒcsrfçš„é˜²èŒƒ)

		> Note: the verification is performed because the framework builds in a security plugin [egg-security](https://github.com/eggjs/egg-security) that provides some default security practices and this plugin is enabled by default. In case you want to disable some security protections, just configure the enable attribute of if to be false.


		> Note: the verification is performed because the framework builds in a security plugin [egg-security](https://github.com/eggjs/egg-security) that provides some default security practices and this plugin is enabled by default. In case you want to disable some security protections, just configure the enable attribute of if to be false.

		> "Unless you know the consequence consciously, it's recommended not to disable functions provided by the security plugin"


		### Using Middleware

		A middleware can be used to change the request parameter of one kind of user requests to uppercase.


		### Too Many Routing Maps?

		As described above, we do not recommend you scatter routing logics all around, or it leads to a difficult trouble shooting.

docs(basics/router.md): [translate] Done #896

docs(basics/router.md): [translate] Done #896

Conversation

lslxdx commented May 11, 2017 • edited

Checklist

Affected core subsystem(s)

Description of change

codecov bot commented May 11, 2017 • edited

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

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

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

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

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

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

lslxdx commented May 11, 2017 •

edited

codecov bot commented May 11, 2017 •

edited