n8n-docs
n8n-docs copied to clipboard
n8n-io
Add makefile
Adds a Makefile to check Python version, set up venv and install requirements, Also updates contributing guide to cover the new process.
Deploy Preview for n8n-docs ready!
| Name | Link |
|---|---|
| Latest commit | 334dce3594b52b5572687ebd9e5dde87ef489e28 |
| Latest deploy log | https://app.netlify.com/sites/n8n-docs/deploys/67c06b164455930008d822fb |
| Deploy Preview | https://deploy-preview-2917--n8n-docs.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Summary
| Status | Count |
|---|---|
| 🔍 Total | 12 |
| ✅ Successful | 9 |
| ⏳ Timeouts | 0 |
| 🔀 Redirected | 0 |
| 👻 Excluded | 3 |
| ❓ Unknown | 0 |
| 🚫 Errors | 0 |
| Full Github Actions output |
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Overall readability score: 44.72 (🟢 +0)
| File | Readability |
|---|---|
| README.md | 62.52 (🟢 +0) |
View detailed metrics
🟢 - Shows an increase in readability 🔴 - Shows a decrease in readability
| File | Readability | FRE | GF | ARI | CLI | DCRS |
|---|---|---|---|---|---|---|
| README.md | 62.52 | 51.14 | 9.25 | 9.9 | 11.7 | 8.05 |
| 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 |
Averages:
| Readability | FRE | GF | ARI | CLI | DCRS | |
|---|---|---|---|---|---|---|
| Average | 44.72 | 36.11 | 11.54 | 14.54 | 14.21 | 8.39 |
| 🟢 +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 |
@Joffcom couple of questions:
- Would need people to install Make (it's not there by default on Windows at least)
- Potentially introduces confusion, if we're encouraging users to use
make run, but in practice most of the time they'll need varied commands for testing depending on how much/how slow they want to build.
What's the benefit of using the Make file and adding another tool folks need to install? Happy to test it and use it if it's worth it.
I think back when I added it there was some confusion on getting up and running, this gives us a consistent approach to it but would require make to be available.
There may be a better way to handle this
@Joffcom I'm torn because I'm aware using makefiles on Python projects is a pretty standard good practice. Equally, it's one more thing to install, and I'm wondering if we can just make the README / internal docs clearer? Either way we have to handle supporting OS differences (I don't think the current commands will activate venv on Windows, for instance)
