search

n8n-io / n8n-docs

Documentation for n8n, a fair-code licensed automation tool with a free community edition and powerful enterprise options. Build AI functionality into your workflows.
https://docs.n8n.io
Other
178 stars 348 forks source link

Node overhaul: Schedule Trigger #2341

Closed ayatnkw closed 1 month ago

ayatnkw commented 2 months ago

Changes

netlify[bot] commented 2 months ago

Deploy Preview for n8n-docs ready!

Name Link
Latest commit 03f1270350b5ca98d7c5457ef87e72240f2c4413
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/66df1573c8b38d0009b10521
Deploy Preview https://deploy-preview-2341--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.

github-actions[bot] commented 2 months ago

Overall readability score: 43.59 (🟢 +0)

File Readability
n8n-nodes-base.scheduletrigger.md 90.34 (🟢 +3.14)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [n8n-nodes-base.scheduletrigger.md](https://github.com/n8n-io/n8n-docs/blob/03f1270350b5ca98d7c5457ef87e72240f2c4413/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger.md "docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger.md") | 90.34 | 77.23 | 6 | 6.8 | 8.22 | 5.4   | 🟢 +3.14 | 🟢 +1.22 | 🟢 +0.36 | 🟢 +0.9 | 🟢 +0.58 | 🟢 +0.06 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 43.59 | 35.16 | 11.61 | 14.79 | 14.29 | 8.51   | 🟢 +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
freakwriter commented 2 months ago

@ayatnkw the Cron examples seem good, but it feels like you tried to turn the Node parameters list into a table of contents when it's not a table of contents--it's just a list of the various parameter options...?

ayatnkw commented 2 months ago

I don't think the list in Node parameters should function as a table of contents. I'd likely stick with the "Choose from..." list and keep just the time intervals as options, and maybe add a sentence after that list to "Refer to Templates and examples for more examples." or something.

I agree, I've reverted the changes I made, sorry about that!

freakwriter commented 2 months ago

I don't think the list in Node parameters should function as a table of contents. I'd likely stick with the "Choose from..." list and keep just the time intervals as options, and maybe add a sentence after that list to "Refer to Templates and examples for more examples." or something.

I agree, I've reverted the changes I made, sorry about that!

No worries! We're still figuring this out as we go, and you made plenty of other changes here. :)

freakwriter commented 2 months ago

@ayatnkw I'm not seeing any commits from my last review--is it possible you didn't push your changes?