Skip to content

Commit 37313b4

Browse files
committed
Modified pages to discuss chapter composition
1 parent 6fbc650 commit 37313b4

4 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/practice/designing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ title: Designing a flow
1919

2020
### Designing messages
2121

22-
*There are risks that multiple nodes have dependencies by messages passing the nodes.*
22+
*There are risks that multiple nodes have dependencies by messages passing through nodes.*
2323
*For other developers to reuse flows, it is important to design messages so that dependencies get to be relaxed. This chapter proposes a guide about designing message.*
2424

2525
*We have already written actual contents on [here](https://github.com/node-red/node-red.github.io/wiki/Flow-Guideline-Contents).*
@@ -28,7 +28,7 @@ title: Designing a flow
2828

2929
*`msg` is a JavaScript object that contains a key-value structure like JSON. While a `msg` transits across multiple nodes, the nodes use some keys and values of the `msg`. If two or more nodes of them use the same key for different their own purposes, preparing `msg` for input of the nodes is so difficult.*
3030

31-
*Therefore, policies of key-value structure are needed and this subsection describes it as such as followings,*
31+
*Therefore, policies of key-value structure are needed and this subsection describes it as followings,*
3232

3333
* *Top-level keys of `msg` are used to control the functionality of node*
3434
* *`msg.payload` is used as input parameters of a process of a node*
@@ -43,9 +43,9 @@ title: Designing a flow
4343

4444
#### Using persistent storage outside of Node-RED
4545

46-
*If you handle the large amount of data, it is **not** recommended to set the data into `msg` since `msg` can be a cause of a lack of memory. Instead, you had better put the data on a persistent storage that is in outside of Node-RED and use reference to the data for handling the data.*
46+
*If you handle the large amount of data, it is **not** recommended to set the data into `msg` since `msg` can exhaust available memory. Instead, you had better put the data on a persistent storage that is outside of Node-RED and use reference to the data for handling the data.*
4747

48-
#### Processing in order of arrival of messages
48+
#### Processing messages in order of their arrival
4949

5050
*Since Node-RED (JavaScript) processes asynchronously, a node cannot assume that it executes process for arrival `msgs` by the order of arrival.*
5151

docs/practice/implementation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ title: Implementation of flow
1010

1111
*Http in/out/request nodes are useful for the integration. However, if you do not want to expose endpoints of small flows, you can make sub flows from the small flows and create an additional flow to integrate sub flows.*
1212

13-
### Managing environmental variables
13+
### Managing flow parameter
1414

15-
*Global context can be used as an environmental variable of flow execution. However, if you use the global context in various nodes, identifying dependencies between nodes becomes a hard work, and it can lead to bugs. To minimize the dependence on the global context, it is necessary to make it easier to see where the global context is used.*
15+
*Global context can be used as a parameter of flow execution. However, if you use the global context in various nodes, identifying dependencies between nodes becomes a hard work, and it can lead to bugs. To minimize the dependence on the global context, it is necessary to make it easier to see where the global context is used.*
1616

1717
### Flows that can have adverse effects
1818

19-
*With Node-RED, even non-programmers can easily enjoy coding. However, Node-RED (as of 0.19.5) does not strict restrictions on creating flows and debugging tools such as a lint, you can easily create dangerous flows that can cause bugs. In particular, it is also possible to lead to resource exhaustion of Node-RED engine.*
19+
*With Node-RED, even non-programmers can easily enjoy coding. However, Node-RED (as of 0.19.5) does not place strict restrictions on creating flows and does not provide debugging tools such as a lint. Thus, you can easily create dangerous flows that can cause bugs. In particular, it is also possible to lead to resource exhaust of Node-RED engine.*
2020

21-
*This chapter shows certain cautions and principles not to create such dangerous flows.*
21+
*This chapter shows certain cautions and principles preventing from creating such dangerous flows.*
2222

2323
### Error Handling
2424

docs/practice/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
layout: docs
33
toc: practice-toc.html
4-
title: Introduce
4+
title: Introduction
55
---
6-
*This guide is for who understands the basic fuctinality and want to develop more clear and reusable flows. If you thik that you are beginner, please read **[User Guide](https://nodered.org/docs/user-guide/)** and **[Cookbook](https://cookbook.nodered.org/)** first.*
6+
*This guide is for developers who understand the basic fuctinality and want to develop more clear and reusable flows. If you think that you are beginner, please read **[User Guide](https://nodered.org/docs/user-guide/)** and **[Cookbook](https://cookbook.nodered.org/)** first.*
77

8-
*In Node-RED, users can create flows easily and ad hoc. However, if you want to create more reusable and readable flows, some tips, practices and know how may be needed. Therefore, we would propose to create a new flow development guideline page to show such knowledge on Node-RED official page. We believe this page is useful for most Node-RED users.*
8+
*In Node-RED, users can create flows easily and in ad hoc manner. However, if you want to create more reusable and readable flows, some tips, practices and know how may be needed. Therefore, flow development guideline page is intended for gathering such knowledge. We believe this page is useful for most Node-RED users.*
99

1010
*Before adding guideline to the Node-RED official page through a pull request, we would like to discuss contents and where to place it with somebody who are interested in this guideline. This wiki page is for discussing them.*
1111

docs/practice/readability.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ title: Improving readability
99

1010
### Naming rule
1111

12-
*Name of nodes, tabs and subflow is important for readability and reusability of flows. This chapter presents some effective naming rules of them.(italic)*
12+
*Name of nodes, tabs and subflow is important for readability and reusability of flows. This chapter presents some effective naming rules of them.*
1313

1414
### Using proper nodes
1515

1616
*Each node can be used flexibly. For example, a function node can cover the same function of Change node, Switch node and so on. However, using a proper specialized node for your objective contributes improving understandability of your flows. This chapter introduces the roles and usage of core nodes such as **Change, Switch, Template, Link, HTTP**.*
1717

18-
*The **Function** node and **Exec** node are useful for JavaScript and other language developers because they can write JavaScript codes and commands directly. However, heavy use of them makes understanding flow difficult for other developers. This chapter describes a caution of these nodes and shows examples of alternative methods against Function node and Exec node.*
18+
*The **Function** node and **Exec** node are useful for JavaScript and other language developers because they can write JavaScript codes and commands directly. However, heavy use of them makes understanding of flow difficult for other developers. This chapter describes a caution of these nodes and shows examples of alternative methods against Function node and Exec node.*
1919

2020
#### Link node
2121

22-
*You can divide the flows when it be too long by using Link node. And it allows you create flows accroding to the size of the display and makes the layout clean.*
22+
*You can divide the flows when it become too long by using Link node. And it allows you to create flows accroding to the size of the display and makes the layout clean.*
2323

2424
### Changing icon
2525

0 commit comments

Comments
 (0)