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

Add info on defining input items for sub-workflows #2745

Merged
merged 3 commits into from
Jan 10, 2025

Conversation

imchairmanm
Copy link
Contributor

No description provided.

Copy link

netlify bot commented Jan 8, 2025

Deploy Preview for n8n-docs ready!

Name Link
🔨 Latest commit 9e2d75a
🔍 Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/67812617b6763f0008a44046
😎 Deploy Preview https://deploy-preview-2745--n8n-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@imchairmanm imchairmanm requested review from nik8n and evilnick January 8, 2025 18:32
Copy link

github-actions bot commented Jan 8, 2025

Overall readability score: 44.71 (🟢 +0)

File Readability
subworkflow-data-flow.md 78.9 (🔴 -2.37)
subworkflow-usage.md 66.21 (🔴 -0.22)
n8n-nodes-base.executeworkflow.md 74.67 (🔴 -2.67)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
subworkflow-data-flow.md 78.9 65.42 7.83 8.2 9.27 6.28
  🔴 -2.37 🔴 -1.02 🔴 -1 🟢 +0 🟢 +0.11 🔴 -0.2
subworkflow-usage.md 66.21 55.24 8.91 11.6 11.83 6.47
  🔴 -0.22 🔴 -0.1 🟢 +0.11 🔴 -0.2 🔴 -0.46 🟢 +0.17
n8n-nodes-base.executeworkflow.md 74.67 58.89 7.22 9.7 10.77 6.25
  🔴 -2.67 🔴 -1.52 🔴 -0.52 🔴 -0.6 🔴 -0.35 🔴 -0.05

Averages:

  Readability FRE GF ARI CLI DCRS
Average 44.71 35.58 11.38 14.6 14.21 8.43
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Contributor

@evilnick evilnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Some suggested edits in comments

_snippets/flow-logic/subworkflow-usage.md Outdated Show resolved Hide resolved
_snippets/flow-logic/subworkflow-usage.md Outdated Show resolved Hide resolved
_snippets/flow-logic/subworkflow-usage.md Outdated Show resolved Hide resolved
@nik8n
Copy link
Contributor

nik8n commented Jan 9, 2025

Looks mostly good @imchairmanm, thanks for the great work. I have a few feedback points:

  1. In the section on "How to create a sub-workflow" we might want to mention that you can also simply create them from the Execute Workflow node, by choosing the option there.
  2. You mention that "Debug in Editor" is only available in Pro and Enterprise. That is not true anymore. Users also get it on the registered Community version and on the Starter plan. Maybe that slipped through the cracks?
  3. Does it make sense to have the same information in 4 different places? (Trigger, Node, Subworkflow, Flow-logic)

@imchairmanm
Copy link
Contributor Author

Looks mostly good @imchairmanm, thanks for the great work. I have a few feedback points:

  1. In the section on "How to create a sub-workflow" we might want to mention that you can also simply create them from the Execute Workflow node, by choosing the option there.
  2. You mention that "Debug in Editor" is only available in Pro and Enterprise. That is not true anymore. Users also get it on the registered Community version and on the Starter plan. Maybe that slipped through the cracks?
  3. Does it make sense to have the same information in 4 different places? (Trigger, Node, Subworkflow, Flow-logic)

Thanks for taking a look @nik8n! Let me respond to each individually:

  1. Yes, that's a good call. I will add that 👍
  2. I don't think I touched anything related to Debug in Editor (but I also didn't review anything that was already there). Thanks for the heads up, I'll adjust that as well.
  3. Currently, they're mostly all pulling from the same snippets, so in terms of keeping the info in sync, that makes it easy. I didn't implement the current repetition, but if I could guess why it was initially created like that, I'd imagine it's because:
    • Users often have an easier time digesting info if it's in one place rather than spread out, and
    • We want to put info where users think it should be (where they're looking for it)

(Continuing w/ 3 above) with all of that being said, if you think it's confusing, we should reconsider.

@imchairmanm
Copy link
Contributor Author

Okay, I believe I fixed all of the obvious issues identified. We can adjust where we display the info later if we think the current split is confusing.

@imchairmanm imchairmanm merged commit b8ec81c into main Jan 10, 2025
7 checks passed
@imchairmanm imchairmanm deleted the DOC-1197/docs-defining-inputs-for-sub-workflows branch January 10, 2025 14:03
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

Successfully merging this pull request may close these issues.

3 participants