Skip to content

Add introduction of flow-dev-guide #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _includes/developing-flows-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<li><a href="/docs/">&larr; back</a></li>
<li class="tocheader">
<ul>
<li class="toctitle active"><a href="/docs/dveloping-flows/">Developing Flows</a></li>
<li class="toctitle active"><a href="/docs/developing-flows/">Developing Flows</a></li>
<li {% if page.url == "/docs/developing-flows/designing" %}class="active"{% endif %}><a href="/docs/developing-flows/designing">Designing</a></li>
<li {% if page.url == "/docs/developing-flows/implementation" %}class="active"{% endif %}><a href="/docs/developing-flows/implementation">Implementation</a></li>
<li {% if page.url == "/docs/developing-flows/readability" %}class="active"{% endif %}><a href="/docs/developing-flows/readability">Readability</a></li>
Expand Down
34 changes: 31 additions & 3 deletions docs/developing-flows/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,38 @@ layout: docs
toc: developing-flows-toc.html
title: Introduction
---
*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.*

*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.*
With Node-RED, you can create an application quickly.
In particular, creating small IoT applications is very easy even if you use Node-RED in an adhoc manner.
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.
Therefore, this Developing Flows guidelines are intended for providing such knowledge.

This guideline assume that you already know basic usage of Node-RED.
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.

### [Designing](designing)

Descriptions about designing strategy before developing flows.

### [Implementation](implementation)

Explanations about phases of the flow implementation.

### [Readability](readability)

Guideline for improving readability to create a reusable flows

### [Project](multiple-developers)

Project management methods for developing flows among multiple people

### [Non-functional requirements](non-functional)

Techniques to meet non-functional requirements.


{% comment %}
*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.*

*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.*
*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.*
{% endcomment %}