docs: EN translation for socketio tutorial doc #2167

cemremengu · 2018-03-05T22:14:20Z

This PR is intended to provide an translation for /tutorials/socketio.md missing in #363

request-info · 2018-03-05T22:14:22Z

The maintainers of this repository would appreciate it if you could provide more information.

codecov · 2018-03-05T22:32:36Z

Codecov Report

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

@@           Coverage Diff           @@
##           master    #2167   +/-   ##
=======================================
  Coverage   99.59%   99.59%           
=======================================
  Files          29       29           
  Lines         749      749           
=======================================
  Hits          746      746           
  Misses          3        3

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 5b059db...3ab3420. Read the comment docs.

SunShinewyf · 2018-03-07T13:54:22Z

docs/source/en/tutorials/socketio.md

+## title: Socket.IO
+
+** Socket.IO ** is a real-time application framework based on NodeJS, which has a wide range of applications including instant messaging, notification and message push, real-time analysis and other scenarios.


这里的 NodeJs还是用Node.js 吧，和中文版保持一致

SunShinewyf · 2018-03-07T14:05:51Z

docs/source/en/tutorials/socketio.md

+
+* namespace: define the namespace by means of configuration
+   - middleware: every socket connection to establish / disconnect, every message / data transfer pretreatment


这一句感觉不太顺，下面的表达方式觉得怎样：
establish / disconnect every socket connection, preprocess every message / data transfer

SunShinewyf · 2018-03-07T14:07:15Z

docs/source/en/tutorials/socketio.md

+* namespace: define the namespace by means of configuration
+   - middleware: every socket connection to establish / disconnect, every message / data transfer pretreatment
+   - conbothtroller: response socket.io event


conbothtroller -> controller

SunShinewyf · 2018-03-07T14:09:03Z

docs/source/en/tutorials/socketio.md

+   - middleware: every socket connection to establish / disconnect, every message / data transfer pretreatment
+   - conbothtroller: response socket.io event
+   - router: unified socket.io event and frame routing configuration processing


configuration processing -> processign configuration 会好一点
建议整句的句型改成下面： unified the processing configuration of socket.io event and frame routing

SunShinewyf · 2018-03-07T14:09:50Z

docs/source/en/tutorials/socketio.md

+```
+
+** Open the plugin: **


open -> enable

SunShinewyf · 2018-03-07T14:32:40Z

docs/source/en/tutorials/socketio.md

+#### Connection
+
+Once a client is connected, you can execute the desired logic. Authentication/Authorization is usually performed in this step to decide which action to take.


这一整句和中文意思好像不是很贴合

SunShinewyf · 2018-03-07T14:33:59Z

docs/source/en/tutorials/socketio.md

+  return async (ctx, next) => {
+    if (true) {
+      ctx.socket.disconnet();


ctx.socket.disconnet() -> ctx.socket.disconnect() 中文文档的这个单词也错了，可以一并处理一下

这个还没有修改

SunShinewyf · 2018-03-07T14:34:55Z

docs/source/en/tutorials/socketio.md

+#### Packet
+
+Packets can be used to preprocess the message or to decrypt an encrypted message.


“在生产环境中，通常用于对消息做预处理” 这一句是不是漏了

SunShinewyf · 2018-03-07T14:36:01Z

docs/source/en/tutorials/socketio.md

+### Controller
+
+A controller deals with the events sent by the client. Since it inherits the `egg.Contoller`, it has the following member objects:


egg.contoller -> egg.controller 中文文档也错了，一并处理一下

SunShinewyf · 2018-03-07T14:37:41Z

docs/source/en/tutorials/socketio.md

+  io.of('/').route('server', io.controller.home.server);
+};
+```


中文中后面还有好多内容，好像没有翻译完？

Sorry about this, google translate truncated the text. Added the rest now.

xie xie for your time 😄

cemremengu · 2018-03-18T03:52:08Z

@SunShinewyf 👀

SunShinewyf · 2018-03-24T13:42:23Z

docs/source/en/tutorials/socketio.md

+```
+
+** Enabling the plugin: **


Enabling->Enable

SunShinewyf · 2018-03-24T13:48:08Z

docs/source/en/tutorials/socketio.md

+- `disconnecting` doing the disconnect
+- `disconnect` connection has disconnected.
+- `error` Error occured


occured->occurred, 中文的好像也错了，一并改一下~

SunShinewyf · 2018-03-24T13:50:10Z

docs/source/en/tutorials/socketio.md

+#### Namespace (nsp)
+
+The namespace is usually meant to be assigned to different access points or paths. If the client does not specify an nsp, it is assigned to the default namespace "/" by default.


an nsp->a nsp

the default namespace 和后面的by default有点重复，建议： it is assigned to "/" by default

SunShinewyf · 2018-03-24T13:52:46Z

docs/source/en/tutorials/socketio.md

+     Ctx.app.io.of('/').to(room).emit('online', { msg: 'welcome', id: ctx.socket.id });
+     Await next();
+     Console.log('disconnection!');


这几行的代码首字母为啥要大写？

SunShinewyf · 2018-03-24T13:54:27Z

docs/source/en/tutorials/socketio.md

+## Examples
+
+Here we use [egg-socket.io] to do a small example of supporting p2p chat


of supporting p2p chat 建议改为：which supports p2p chat

SunShinewyf · 2018-03-24T13:56:09Z

docs/source/en/tutorials/socketio.md

+   Window.socket = socket;
+};
+```


这里的代码片段首字母都大写了？

SunShinewyf · 2018-03-24T13:56:35Z

docs/source/en/tutorials/socketio.md

+   Console.log('res from server: %s!', msg);
+});
+```


SunShinewyf · 2018-03-24T13:56:49Z

docs/source/en/tutorials/socketio.md

+   },
+};
+```


SunShinewyf · 2018-03-24T13:59:21Z

docs/source/en/tutorials/socketio.md

+
+P2P communication, data exchange through exchange
+


这句话感觉和中文不太相符
data exchange of P2P communication is through exchange

SunShinewyf · 2018-03-24T14:00:06Z

docs/source/en/tutorials/socketio.md

+[socket.io]: https://socket.io
+[egg-socket.io]: https://github.com/eggjs/egg-socket.io
+[uws]: https://github.com/uWebSockets/uWebSockets


代码片段首字母大写，可以注意一下~

Didn't understand what you mean here

SunShinewyf · 2018-03-26T02:01:30Z

@atian25 可以合并了~

docs: EN translation for socketio tutorial doc (#2167)

Updated socketio tutorial doc

58f6ac2

atian25 requested a review from SunShinewyf March 6, 2018 12:14

SunShinewyf reviewed Mar 7, 2018

View reviewed changes

cemremengu added 2 commits March 15, 2018 17:11

Updated based on comments

5ff03b8

Changed connection part

7c0cd14

cemremengu changed the title ~~Updated socketio tutorial doc~~ EN translation for socketio tutorial doc Mar 19, 2018

SunShinewyf reviewed Mar 24, 2018

View reviewed changes

Updated based on comments

de9f725

Merge branch 'master' into socketio-doc

3ab3420

atian25 changed the title ~~EN translation for socketio tutorial doc~~ docs: EN translation for socketio tutorial doc Mar 26, 2018

popomore approved these changes Mar 26, 2018

View reviewed changes

atian25 merged commit 10327e1 into eggjs:master Mar 26, 2018

cemremengu deleted the socketio-doc branch March 26, 2018 02:46

popomore pushed a commit that referenced this pull request Mar 26, 2018

docs: auto generate by ci

ebb5adb

docs: EN translation for socketio tutorial doc (#2167)

lqzhgood mentioned this pull request Aug 21, 2019

docs: fix typo of socket.io #3895

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: EN translation for socketio tutorial doc #2167

docs: EN translation for socketio tutorial doc #2167

cemremengu commented Mar 5, 2018 •

edited

Loading

request-info bot commented Mar 5, 2018

codecov bot commented Mar 5, 2018 •

edited

Loading

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

whlsxl Dec 4, 2018

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

SunShinewyf Mar 7, 2018

cemremengu Mar 15, 2018 •

edited

Loading

cemremengu commented Mar 18, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

SunShinewyf Mar 24, 2018

cemremengu Mar 24, 2018

SunShinewyf commented Mar 26, 2018

		## title: Socket.IO

		Socket.IO is a real-time application framework based on NodeJS, which has a wide range of applications including instant messaging, notification and message push, real-time analysis and other scenarios.


		* namespace: define the namespace by means of configuration
		- middleware: every socket connection to establish / disconnect, every message / data transfer pretreatment

		#### Connection

		Once a client is connected, you can execute the desired logic. Authentication/Authorization is usually performed in this step to decide which action to take.

		#### Packet

		Packets can be used to preprocess the message or to decrypt an encrypted message.

		### Controller

		A controller deals with the events sent by the client. Since it inherits the `egg.Contoller`, it has the following member objects:

		#### Namespace (nsp)

		The namespace is usually meant to be assigned to different access points or paths. If the client does not specify an nsp, it is assigned to the default namespace "/" by default.

		## Examples

		Here we use [egg-socket.io] to do a small example of supporting p2p chat

docs: EN translation for socketio tutorial doc #2167

docs: EN translation for socketio tutorial doc #2167

Conversation

cemremengu commented Mar 5, 2018 • edited Loading

request-info bot commented Mar 5, 2018

codecov bot commented Mar 5, 2018 • 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

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

cemremengu Mar 15, 2018 • edited Loading

Choose a reason for hiding this comment

cemremengu commented Mar 18, 2018

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

SunShinewyf commented Mar 26, 2018

cemremengu commented Mar 5, 2018 •

edited

Loading

codecov bot commented Mar 5, 2018 •

edited

Loading

cemremengu Mar 15, 2018 •

edited

Loading