Skip to content

Commit 32a275b

Browse files
committed
Add contents of introduction
1 parent 8203277 commit 32a275b

2 files changed

Lines changed: 32 additions & 4 deletions

File tree

_includes/developing-flows-toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<li><a href="/docs/">&larr; back</a></li>
44
<li class="tocheader">
55
<ul>
6-
<li class="toctitle active"><a href="/docs/dveloping-flows/">Developing Flows</a></li>
6+
<li class="toctitle active"><a href="/docs/developing-flows/">Developing Flows</a></li>
77
<li {% if page.url == "/docs/developing-flows/designing" %}class="active"{% endif %}><a href="/docs/developing-flows/designing">Designing</a></li>
88
<li {% if page.url == "/docs/developing-flows/implementation" %}class="active"{% endif %}><a href="/docs/developing-flows/implementation">Implementation</a></li>
99
<li {% if page.url == "/docs/developing-flows/readability" %}class="active"{% endif %}><a href="/docs/developing-flows/readability">Readability</a></li>

docs/developing-flows/index.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,38 @@ layout: docs
33
toc: developing-flows-toc.html
44
title: Introduction
55
---
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.*
76

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.*
7+
With Node-RED, you can create an application quickly.
8+
In particular, creating small IoT applications is very easy even if you use Node-RED in an adhoc manner.
9+
However, if you create relatively large applications or create applications with your team, like an enterprise development, you may want practices and tips to create more reusable and readable flows.
10+
Therefore, this Developing Flows guidelines are intended for providing such knowledge.
911

12+
This guideline assume that you already know basic usage of Node-RED.
13+
If you are a starter and you want to know just how to use Node-RED, please read [User Guide](https://nodered.org/docs/user-guide/) and [Cookbook](https://cookbook.nodered.org/) first.
14+
15+
### [Designing](designing)
16+
17+
Descriptions about designing strategy before developing flows.
18+
19+
### [Implementation](implementation)
20+
21+
Explanations about phases of the flow implementation.
22+
23+
### [Readability](readability)
24+
25+
Guideline for improving readability to create a reusable flows
26+
27+
### [Project](multiple-developers)
28+
29+
Project management methods for developing flows among multiple people
30+
31+
### [Non-functional requirements](non-functional)
32+
33+
Techniques to meet non-functional requirements.
34+
35+
36+
<!--
1037
*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.*
1138
12-
*At first, we’d like to show a contents list and where to place it on Node-RED official page. After that, we will write the actual contents and discuss it with Node-RED community because we would reduce unnecessary work.*
39+
*At first, we’d like to show a contents list and where to place it on Node-RED official page. After that, we will write the actual contents and discuss it with Node-RED community because we would reduce unnecessary work.*
40+
-->

0 commit comments

Comments
 (0)