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
134 stars 251 forks source link

DOC-912: Standardize creds intros and other small fixes #2170

Closed freakwriter closed 3 weeks ago

freakwriter commented 1 month ago

This PR addresses three issues:

netlify[bot] commented 1 month ago

Deploy Preview for n8n-docs ready!

Name Link
Latest commit 47c500ed68a0c2a41113bc9f4e026afc0a532c7b
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/66707f85899a2e0008d6057d
Deploy Preview https://deploy-preview-2170--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 1 month ago

Overall readability score: 41.61 (🔴 -0.3)

File Readability
acuityscheduling.md 22.06 (🔴 -0.39)
adalo.md 49.63 (🔴 -0.68)
affinity.md 38.1 (🟢 +0.17)
agilecrm.md 49.39 (🔴 -1.43)
airtable.md 58.03 (🟢 +0.15)
alienvault.md 24.3 (🔴 -26.18)
auth0management.md 15.39 (🔴 -21.59)
bitbucket.md 40.95 (🟢 +0.41)
cal.md 54.26 (🔴 -0.61)
calendly.md 20.4 (🔴 -0.89)
carbonblack.md 44.33 (🔴 -12.76)
chargebee.md 52.88 (🟢 +0.07)
circleci.md 30.11 (🔴 -0.89)
ciscomeraki.md 21.38 (🔴 -20.21)
ciscosecureendpoint.md 39.76 (🔴 -12.2)
ciscoumbrella.md 22.42 (🔴 -20.27)
crowdstrike.md 56.01 (🔴 -9.31)
elasticsearch.md 48.17 (🟢 +3.81)
emelia.md 47.11 (🔴 -0.66)
f5bigip.md 39.23 (🔴 -20.9)
facebookapp.md 47.03 (🟢 +0.05)
facebookgraph.md 34.95 (🔴 -0.06)
fortigate.md 15.58 (🔴 -16.62)
gumroad.md 34.76 (🔴 -0.66)
hybridanalysis.md 19.33 (🔴 -23.24)
impervawaf.md 15.99 (🔴 -23.47)
kibana.md 44.14 (🔴 -15.02)
mautic.md 66.3 (🟢 +0.03)
microsoftentra.md 30.07 (🔴 -8.53)
mist.md 43.99 (🔴 -11.38)
okta.md 60.43 (🔴 -8.63)
opencti.md 20.23 (🔴 -22.23)
qradar.md 24.45 (🔴 -21.92)
qualys.md 25.75 (🔴 -23.92)
recordedfuture.md 26.71 (🔴 -20.84)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [acuityscheduling.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/acuityscheduling.md "docs/integrations/builtin/credentials/acuityscheduling.md") | 22.06 | 7.62 | 12.72 | 19.1 | 19 | 9.19   | 🔴 -0.39 | 🟢 +0.4 | 🔴 -0.09 | 🟢 +0.1 | 🟢 +0 | 🔴 -0.14 [adalo.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/adalo.md "docs/integrations/builtin/credentials/adalo.md") | 49.63 | 27.69 | 9.05 | 14.1 | 15.58 | 7.36   | 🔴 -0.68 | 🟢 +0.2 | 🔴 -0.05 | 🔴 -0.1 | 🔴 -0.18 | 🔴 -0.07 [affinity.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/affinity.md "docs/integrations/builtin/credentials/affinity.md") | 38.1 | 18.72 | 10.57 | 15.4 | 16.97 | 8.48   | 🟢 +0.17 | 🟢 +0.41 | 🔴 -0.04 | 🟢 +0.1 | 🟢 +0.29 | 🔴 -0.12 [agilecrm.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/agilecrm.md "docs/integrations/builtin/credentials/agilecrm.md") | 49.39 | 37.47 | 10.46 | 12 | 13.77 | 8.93   | 🔴 -1.43 | 🟢 +0.41 | 🔴 -0.14 | 🔴 -0.3 | 🔴 -0.17 | 🔴 -0.18 [airtable.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/airtable.md "docs/integrations/builtin/credentials/airtable.md") | 58.03 | 33.61 | 8.3 | 12.8 | 14.6 | 6.47   | 🟢 +0.15 | 🟢 +0.1 | 🟢 +0.01 | 🟢 +0.1 | 🟢 +0 | 🔴 -0.01 [alienvault.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/alienvault.md "docs/integrations/builtin/credentials/alienvault.md") | 24.3 | 12.7 | 10.14 | 19.3 | 19 | 10.04   | 🔴 -26.18 | 🔴 -24.36 | 🔴 -1.08 | 🔴 -6.6 | 🔴 -4.36 | 🔴 -1.42 [auth0management.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/auth0management.md "docs/integrations/builtin/credentials/auth0management.md") | 15.39 | 1.5 | 11.81 | 21.5 | 19 | 10.35   | 🔴 -21.59 | 🔴 -24.56 | 🔴 -1.1 | 🔴 -6 | 🔴 -1.97 | 🔴 -1.29 [bitbucket.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/bitbucket.md "docs/integrations/builtin/credentials/bitbucket.md") | 40.95 | 25.86 | 10.27 | 15.6 | 17.79 | 7.67   | 🟢 +0.41 | 🟢 +0.2 | 🔴 -0.01 | 🟢 +0.1 | 🟢 +0.29 | 🔴 -0.05 [cal.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/cal.md "docs/integrations/builtin/credentials/cal.md") | 54.26 | 42.07 | 10.04 | 13.1 | 13.79 | 7.37   | 🔴 -0.61 | 🟢 +0.3 | 🟢 +0 | 🔴 -0.1 | 🔴 -0.23 | 🔴 -0.06 [calendly.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/calendly.md "docs/integrations/builtin/credentials/calendly.md") | 20.4 | 2.61 | 12.92 | 17.8 | 19 | 9.93   | 🔴 -0.89 | 🟢 +0.3 | 🔴 -0.19 | 🟢 +0 | 🟢 +0 | 🔴 -0.19 [carbonblack.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/carbonblack.md "docs/integrations/builtin/credentials/carbonblack.md") | 44.33 | 27.89 | 8.32 | 15.7 | 17.08 | 8.03   | 🔴 -12.76 | 🔴 -7.95 | 🔴 -0.34 | 🔴 -3.2 | 🔴 -3.13 | 🔴 -0.56 [chargebee.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/chargebee.md "docs/integrations/builtin/credentials/chargebee.md") | 52.88 | 35.95 | 10.22 | 12.6 | 14.53 | 7.29   | 🟢 +0.07 | 🟢 +0.21 | 🔴 -0.05 | 🟢 +0.1 | 🟢 +0.12 | 🔴 -0.06 [circleci.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/circleci.md "docs/integrations/builtin/credentials/circleci.md") | 30.11 | 11.78 | 12.58 | 15 | 17.6 | 9.44   | 🔴 -0.89 | 🟢 +0.4 | 🔴 -0.17 | 🟢 +0 | 🔴 -0.06 | 🔴 -0.18 [ciscomeraki.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/ciscomeraki.md "docs/integrations/builtin/credentials/ciscomeraki.md") | 21.38 | 0 | 10.56 | 19.9 | 19 | 9.8   | 🔴 -20.21 | 🔴 -19.33 | 🔴 -0.91 | 🔴 -5.4 | 🔴 -2.84 | 🔴 -1.12 [ciscosecureendpoint.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/ciscosecureendpoint.md "docs/integrations/builtin/credentials/ciscosecureendpoint.md") | 39.76 | 20.65 | 8.69 | 15.4 | 17.19 | 8.97   | 🔴 -12.2 | 🔴 -7.95 | 🔴 -0.39 | 🔴 -3 | 🔴 -2.72 | 🔴 -0.63 [ciscoumbrella.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/ciscoumbrella.md "docs/integrations/builtin/credentials/ciscoumbrella.md") | 22.42 | 2.31 | 10.74 | 19.5 | 19 | 9.68   | 🔴 -20.27 | 🔴 -24.67 | 🔴 -0.83 | 🔴 -5 | 🔴 -3.02 | 🔴 -1.01 [crowdstrike.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/crowdstrike.md "docs/integrations/builtin/credentials/crowdstrike.md") | 56.01 | 35.64 | 8.02 | 12.4 | 14.13 | 7.74   | 🔴 -9.31 | 🔴 -8.05 | 🔴 -0.23 | 🔴 -2.3 | 🔴 -2.03 | 🔴 -0.43 [elasticsearch.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/elasticsearch.md "docs/integrations/builtin/credentials/elasticsearch.md") | 48.17 | 35.34 | 8.88 | 14.5 | 16.51 | 7.71   | 🟢 +3.81 | 🟢 +9.07 | 🟢 +0.15 | 🟢 +0.9 | 🟢 +0.64 | 🔴 -0.05 [emelia.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/emelia.md "docs/integrations/builtin/credentials/emelia.md") | 47.11 | 19.13 | 10.34 | 12.5 | 14.42 | 8.25   | 🔴 -0.66 | 🟢 +0.21 | 🔴 -0.1 | 🟢 +0 | 🔴 -0.12 | 🔴 -0.11 [f5bigip.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/f5bigip.md "docs/integrations/builtin/credentials/f5bigip.md") | 39.23 | 27.89 | 10.07 | 15.2 | 15.87 | 9.44   | 🔴 -20.9 | 🔴 -16.11 | 🔴 -0.8 | 🔴 -4.8 | 🔴 -4.53 | 🔴 -1.09 [facebookapp.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/facebookapp.md "docs/integrations/builtin/credentials/facebookapp.md") | 47.03 | 32.09 | 9.64 | 15.5 | 16.17 | 7.19   | 🟢 +0.05 | 🟢 +0.1 | 🔴 -0.01 | 🟢 +0.1 | 🟢 +0 | 🔴 -0.03 [facebookgraph.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/facebookgraph.md "docs/integrations/builtin/credentials/facebookgraph.md") | 34.95 | 23.73 | 10.06 | 18.2 | 18.78 | 7.93   | 🔴 -0.06 | 🟢 +0.3 | 🟢 +0.03 | 🟢 +0 | 🟢 +0 | 🔴 -0.05 [fortigate.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/fortigate.md "docs/integrations/builtin/credentials/fortigate.md") | 15.58 | 0 | 10.96 | 22 | 19 | 10.44   | 🔴 -16.62 | 🔴 -10.67 | 🔴 -0.94 | 🔴 -5.7 | 🔴 -0.76 | 🔴 -1.21 [gumroad.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/gumroad.md "docs/integrations/builtin/credentials/gumroad.md") | 34.76 | 19.03 | 10.86 | 15.4 | 17.61 | 9.1   | 🔴 -0.66 | 🟢 +0.31 | 🔴 -0.07 | 🟢 +0 | 🔴 -0.12 | 🔴 -0.13 [hybridanalysis.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/hybridanalysis.md "docs/integrations/builtin/credentials/hybridanalysis.md") | 19.33 | 0 | 11.05 | 20.6 | 19 | 9.86   | 🔴 -23.24 | 🔴 -19.63 | 🔴 -1.17 | 🔴 -6.4 | 🔴 -3.2 | 🔴 -1.3 [impervawaf.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/impervawaf.md "docs/integrations/builtin/credentials/impervawaf.md") | 15.99 | 0 | 12.12 | 21.5 | 19 | 9.92   | 🔴 -23.47 | 🔴 -26.88 | 🔴 -1.29 | 🔴 -6.5 | 🔴 -2.26 | 🔴 -1.3 [kibana.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/kibana.md "docs/integrations/builtin/credentials/kibana.md") | 44.14 | 27.49 | 9.82 | 14.2 | 15.29 | 8.73   | 🔴 -15.02 | 🔴 -16.31 | 🔴 -0.54 | 🔴 -3.4 | 🔴 -2.96 | 🔴 -0.71 [mautic.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/mautic.md "docs/integrations/builtin/credentials/mautic.md") | 66.3 | 42.88 | 8.09 | 10.2 | 11.64 | 6.96   | 🟢 +0.03 | 🟢 +0 | 🔴 -0.03 | 🟢 +0.1 | 🟢 +0 | 🔴 -0.02 [microsoftentra.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/microsoftentra.md "docs/integrations/builtin/credentials/microsoftentra.md") | 30.07 | 15.17 | 10.7 | 18.1 | 18.9 | 8.66   | 🔴 -8.53 | 🔴 -8.26 | 🔴 -0.15 | 🔴 -2.2 | 🔴 -2.2 | 🔴 -0.19 [mist.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/mist.md "docs/integrations/builtin/credentials/mist.md") | 43.99 | 18.11 | 8.26 | 15.2 | 16.1 | 8.32   | 🔴 -11.38 | 🔴 -16.52 | 🔴 -0.2 | 🔴 -2.4 | 🔴 -2.37 | 🔴 -0.46 [okta.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/okta.md "docs/integrations/builtin/credentials/okta.md") | 60.43 | 44.2 | 7.76 | 11.3 | 12.15 | 8.31   | 🔴 -8.63 | 🔴 -8.06 | 🔴 -0.19 | 🔴 -2.1 | 🔴 -1.73 | 🔴 -0.46 [opencti.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/opencti.md "docs/integrations/builtin/credentials/opencti.md") | 20.23 | 0 | 10.91 | 20.1 | 19 | 9.88   | 🔴 -22.23 | 🔴 -20.04 | 🔴 -1.09 | 🔴 -6 | 🔴 -3.08 | 🔴 -1.24 [qradar.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/qradar.md "docs/integrations/builtin/credentials/qradar.md") | 24.45 | 3.93 | 10.11 | 18.3 | 19 | 10.01   | 🔴 -21.92 | 🔴 -24.57 | 🔴 -0.85 | 🔴 -5.1 | 🔴 -3.78 | 🔴 -1.14 [qualys.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/qualys.md "docs/integrations/builtin/credentials/qualys.md") | 25.75 | 11.88 | 10.15 | 17.6 | 18.93 | 10.34   | 🔴 -23.92 | 🔴 -24.57 | 🔴 -0.88 | 🔴 -5.2 | 🔴 -4.81 | 🔴 -1.25 [recordedfuture.md](https://github.com/n8n-io/n8n-docs/blob/47c500ed68a0c2a41113bc9f4e026afc0a532c7b/docs/integrations/builtin/credentials/recordedfuture.md "docs/integrations/builtin/credentials/recordedfuture.md") | 26.71 | 3.12 | 8.54 | 19.1 | 19 | 9.74   | 🔴 -20.84 | 🔴 -24.57 | 🔴 -0.54 | 🔴 -5.3 | 🔴 -3.25 | 🔴 -1.11 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 41.61 | 34.53 | 12.03 | 15.23 | 14.31 | 8.66   | 🔴 -0.3 | 🔴 -0.28 | 🔴 -0.01 | 🔴 -0.07 | 🔴 -0.05 | 🔴 -0.02
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