n8n-docs
n8n-docs copied to clipboard
DOC-975: Update Slack credential to High priority template
Also update Slack node and Slack Trigger node
Deploy Preview for n8n-docs ready!
| Name | Link |
|---|---|
| Latest commit | 66ecb41927e0f55a622a7090c9d4f988b14a8735 |
| Latest deploy log | https://app.netlify.com/sites/n8n-docs/deploys/66b24210853c4500087fa683 |
| Deploy Preview | https://deploy-preview-2283--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.
Overall readability score: 42.43 (🟢 +0.09)
| File | Readability |
|---|---|
| n8n-nodes-base.slack.md | 75.35 (🟢 +74.95) |
| slack.md | 76.61 (🟢 +5.1) |
| n8n-nodes-base.slacktrigger.md | 71.3 (🟢 +19.61) |
View detailed metrics
🟢 - Shows an increase in readability 🔴 - Shows a decrease in readability
| File | Readability | FRE | GF | ARI | CLI | DCRS |
|---|---|---|---|---|---|---|
| n8n-nodes-base.slack.md | 75.35 | 61.02 | 7.41 | 8.6 | 9.89 | 6.93 |
| 🟢 +74.95 | 🟢 +58.57 | 🟢 +11.59 | 🟢 +13.4 | 🟢 +9.11 | 🟢 +4.07 | |
| slack.md | 76.61 | 59.9 | 6.49 | 9.4 | 10.71 | 6.25 |
| 🟢 +5.1 | 🟢 +8.56 | 🔴 -0.2 | 🟢 +1.8 | 🟢 +1.62 | 🔴 -0.27 | |
| n8n-nodes-base.slacktrigger.md | 71.3 | 65.62 | 8.4 | 10.3 | 10.55 | 6.84 |
| 🟢 +19.61 | 🟢 +9.74 | 🟢 +4.45 | 🟢 +4 | 🟢 +0.13 | 🟢 +1.36 |
Averages:
| Readability | FRE | GF | ARI | CLI | DCRS | |
|---|---|---|---|---|---|---|
| Average | 42.43 | 34.31 | 11.77 | 15 | 14.44 | 8.59 |
| 🟢 +0.09 | 🟢 +0.07 | 🟢 +0.01 | 🟢 +0.02 | 🟢 +0.01 | 🟢 +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 could I get you to review this PR? I started out just trying to update the credential but ended up touching the app node and trigger node since I was researching the methods/scopes anyway. I'm a bit on the fence about whether to show the required scopes on the credential page itself or to keep them in the separate node pages...anyway, I want to be sure the node documentation itself is correct, and if you have opinions on the scope stuff, I'm all ears, since I think I wrote myself in circles on this.
@freakwriter so I think I would put the scopes at the bottom of the doc maybe in a table as the same scopes will be needed for both oauth and app tokens so we can just link to the table from both.
for OAuth the scopes we will request are below if that helps as well.
'channels:read',
'channels:write',
'chat:write',
'files:read',
'files:write',
'groups:read',
'im:read',
'mpim:read',
'reactions:read',
'reactions:write',
'stars:read',
'stars:write',
'usergroups:write',
'usergroups:read',
'users.profile:read',
'users.profile:write',
'users:read',
Made a formatting suggestion and fixed a url typo. Also, I noticed a typo in the UI — if you notice something like this while working on the docs, could we maybe start listing them here? @freakwriter
Yup! I haven't had a good place to capture those so I'm happy to log them wherever.
Thanks, @Joffcom , I'm pushing some changes to address this. I appreciate the feedback!
@ayatnkw could you re-review with these changes?