Skip to content
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

flow-dev-guide: choose a name for the guide #93

Open
knolleary opened this issue Feb 5, 2019 · 3 comments
Open

flow-dev-guide: choose a name for the guide #93

knolleary opened this issue Feb 5, 2019 · 3 comments

Comments

@knolleary
Copy link
Member

I'm not sure Practice is quite the right title for this new section. I'd suggest Developing Flows would be more consistent with the other sections.

No need to change anything right away - as discussed, once we have more content in the guide I think it will be easier to identify the right way to integrate it with the existing docs. What you have here is a good start begin collaboration on it.

/cc @LEEHYUKJOO

@LEEHYUKJOO
Copy link
Member

LEEHYUKJOO commented Feb 6, 2019

Actually, Developing Flows is nice for consistent with other sections.
However, I guess that readers can misunderstand that just a way to create flows with "Node-RED" (i.e., how to use Node-RED) is written.
The purpose of this guideline is creating flows with readibility, reusability and so on.

So, I'd like to consider title more.



How about bellow alternatives.


  • Developing Effective Flows

  • Developing Better Flows
  • Effective Flows

However, above two are too long to be on 1 line.
Note that, the height of square is dependent on the number of lines.

@knolleary

@knolleary
Copy link
Member Author

I don't think it would be a bad thing to have a single Developer Flows guide that covers the basics and covers best practices. Otherwise we'd have related content split across different parts of the documentation and a user would need to understand that separation. Not suggestion you need to produce that basic content as well - we can contribute those parts - but from an overall structure, maybe they should live together.

@LEEHYUKJOO
Copy link
Member

LEEHYUKJOO commented Feb 7, 2019

I forgot that the contents of the guideline could be added continuously by other users. I realized that Developing Flows is the best title of this guideline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants