proofread docs/index #100
Merged
proofread docs/index #100
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
| ---- | ||
| Node generator is a command line tool to generate Node-RED node modules from several various sources, including Open API document and function node's source. | ||
| Using this tool, node developers can dramatically reduce their time to implement Node-RED node modules. | ||
| Node generator is a command line tool to generate Node-RED nodes based on various source code such as an Open API document or a Function node. |
There was a problem hiding this comment.
source code such as - > sources such as
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
| Node generator is a command line tool to generate Node-RED node modules from several various sources, including Open API document and function node's source. | ||
| Using this tool, node developers can dramatically reduce their time to implement Node-RED node modules. | ||
| Node generator is a command line tool to generate Node-RED nodes based on various source code such as an Open API document or a Function node. | ||
| It helps Node developers dramatically reduce the time to implement Node-RED nodes. |
There was a problem hiding this comment.
It helps Node developers -> It helps developers
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
| But in terms of marketing, instead of http request node, the original node for the cloud services will be effective to increase the number of users because details of node properties, node information and documents will contribute to the usability of the node. | ||
| In general, cloud service providers publish Open API document with REST API for users to test it on Swagger UI. | ||
| Node generator uses this Open API document to create nodes for connection to the cloud service. | ||
| From a marketing perspective, instead of using the http request node, an original node for a cloud service is more effective to increase the number of users because having details of node properties, node information and documents can help contribute to the usability of the node. |
There was a problem hiding this comment.
maybe instead - 'From a marketing perspective, having a dedicated node for a cloud service is more attractive to users because having preset node properties, and targeted information and documents can help improve the usability of the node.
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
| Node generator will support Web of Things description to create original nodes. | ||
| Currently, there are [the slide](https://github.com/w3c/wot/blob/master/plugfest/2018-bundang/images/Plugfest-Bundang-WoT.pdf) and [the screenshot](https://github.com/w3c/wot/blob/master/plugfest/2018-bundang/result-hitachi.md) of the prototype implementation on GitHub. | ||
| Node generator will support the Web of Things specification to create original nodes. | ||
| Currently, there is [the slide](https://github.com/w3c/wot/blob/master/plugfest/2018-bundang/images/Plugfest-Bundang-WoT.pdf) and [the screenshot](https://github.com/w3c/wot/blob/master/plugfest/2018-bundang/result-hitachi.md) of the prototype implementation on GitHub. |
There was a problem hiding this comment.
the slide - > a slide
and
the screenshot -> a screenshot
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
|
|
||
| The current version of Node generator supports function node and Open API document as source files. | ||
| Simply, Node generator command, node-red-nodegen converts to a node from the file which is specified in the argument of the command as follows. | ||
| The Node generator command, node-red-nodegen creates a node from the file which is specified in the argument of the command as follows. |
There was a problem hiding this comment.
The Node generator command, node-red-nodegen creates a node -> node-red-nodegen creates a node
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
| On the palette of Node-RED flow editor, the generated node is in the function category by default. | ||
| To change the category or use the product name, you can use --category option. | ||
| For example, the generated node which the following command outputs will be in the "analysis" category on the Node-RED flow editor. | ||
| For example, the generated node from the following command can be viewed in the "analysis" category on the Node-RED flow editor. |
There was a problem hiding this comment.
the generated node from the -> the node generated from the
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
| On the palette of Node-RED flow editor, the generated node is in the function category as the default. | ||
| To change the category or use product name, you can use --category option. | ||
| For example, the generated node which the following command outputs will be in the "analysis" category on Node-RED flow editor. | ||
| For example, the generated node from the following command can be viewed in the "analysis" category on the Node-RED flow editor. |
There was a problem hiding this comment.
the generated node from the -> the node generated from the
dceejay
reviewed
Jun 30, 2019
docs/index.md
Outdated
|
|
||
| #### Test cases | ||
| The set of test cases is the most important to maintain the quality of the generated node in production use. | ||
| The set of test cases is important to maintaining the quality of the generated node in production use. |
There was a problem hiding this comment.
important to maintaining the -> important in order to maintain the
|
I added some comments to your comments - but yes - good work. |
|
@dceejay Thank you! I have updated the PR to reflect your suggestions. |
|
@chantlong @dceejay Thank you for your contribution! I learned them. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Types of changes
Proposed changes
Fix English Docs to sound more natural...for the most part.