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
154 stars 295 forks source link

DOC-974: Overhaul IMAP credentials #2310

Closed freakwriter closed 1 month ago

freakwriter commented 1 month ago

Summary of changes:

netlify[bot] commented 1 month ago

Deploy Preview for n8n-docs ready!

Name Link
Latest commit d677cea59e4539ae37665b811b7159cc103d0c91
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/66b0f6e80562bf00084f186a
Deploy Preview https://deploy-preview-2310--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: 42.53 (🟢 +0.06)

File Readability
gmail-app-password.md 60.94 (-)
gmail-two-step-verification.md 53 (-)
outlook-app-password.md 73.27 (-)
yahoo-app-password.md 65.58 (-)
gmail.md 48.81 (-)
index.md 75.43 (-)
outlook.md 57.08 (-)
yahoo.md 54.15 (-)
gmail.md 52.36 (🔴 -20.15)
outlook.md 49.95 (🔴 -21.98)
yahoo.md 59.29 (🔴 -16.45)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [gmail-app-password.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/_snippets/integrations/builtin/credentials/email/gmail-app-password.md "_snippets/integrations/builtin/credentials/email/gmail-app-password.md") | 60.94 | 45.93 | 8.11 | 11.6 | 13.19 | 7.46   | - | - | - | - | - | - [gmail-two-step-verification.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/_snippets/integrations/builtin/credentials/email/gmail-two-step-verification.md "_snippets/integrations/builtin/credentials/email/gmail-two-step-verification.md") | 53 | 29.01 | 8.69 | 13.1 | 14.93 | 7.31   | - | - | - | - | - | - [outlook-app-password.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/_snippets/integrations/builtin/credentials/email/outlook-app-password.md "_snippets/integrations/builtin/credentials/email/outlook-app-password.md") | 73.27 | 51.95 | 6.52 | 9.7 | 11.46 | 6.4   | - | - | - | - | - | - [yahoo-app-password.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/_snippets/integrations/builtin/credentials/email/yahoo-app-password.md "_snippets/integrations/builtin/credentials/email/yahoo-app-password.md") | 65.58 | 53.68 | 8.04 | 10.1 | 12.26 | 7.54   | - | - | - | - | - | - [gmail.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/docs/integrations/builtin/credentials/imap/gmail.md "docs/integrations/builtin/credentials/imap/gmail.md") | 48.81 | 35.74 | 8.59 | 14.4 | 16.04 | 7.94   | - | - | - | - | - | - [index.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/docs/integrations/builtin/credentials/imap/index.md "docs/integrations/builtin/credentials/imap/index.md") | 75.43 | 62.34 | 6.95 | 8.1 | 10.52 | 7.17   | - | - | - | - | - | - [outlook.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/docs/integrations/builtin/credentials/imap/outlook.md "docs/integrations/builtin/credentials/imap/outlook.md") | 57.08 | 42.78 | 7.74 | 13.1 | 14.42 | 7.48   | - | - | - | - | - | - [yahoo.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/docs/integrations/builtin/credentials/imap/yahoo.md "docs/integrations/builtin/credentials/imap/yahoo.md") | 54.15 | 43.59 | 8.39 | 12.8 | 14.65 | 8.12   | - | - | - | - | - | - [gmail.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/docs/integrations/builtin/credentials/sendemail/gmail.md "docs/integrations/builtin/credentials/sendemail/gmail.md") | 52.36 | 44 | 8.32 | 14 | 15.23 | 7.94   | 🔴 -20.15 | 🔴 -9.98 | 🔴 -1.93 | 🔴 -3.9 | 🔴 -3.2 | 🔴 -1.56 [outlook.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/docs/integrations/builtin/credentials/sendemail/outlook.md "docs/integrations/builtin/credentials/sendemail/outlook.md") | 49.95 | 42.17 | 8.52 | 14.8 | 15.59 | 7.97   | 🔴 -21.98 | 🔴 -9.38 | 🔴 -1.95 | 🔴 -4.4 | 🔴 -3.78 | 🔴 -1.67 [yahoo.md](https://github.com/n8n-io/n8n-docs/blob/d677cea59e4539ae37665b811b7159cc103d0c91/docs/integrations/builtin/credentials/sendemail/yahoo.md "docs/integrations/builtin/credentials/sendemail/yahoo.md") | 59.29 | 52.26 | 8.01 | 11.8 | 13.38 | 8.18   | 🔴 -16.45 | 🔴 -9.67 | 🔴 -1.48 | 🔴 -3 | 🔴 -2.68 | 🔴 -1.3 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 42.53 | 34.38 | 11.74 | 14.98 | 14.43 | 8.58   | 🟢 +0.06 | 🟢 +0.04 | 🟢 +0.02 | 🟢 +0.01 | 🟢 +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 1 month ago

Updated IMAP to use a similar format to the overhauled Send Email and converted some of the duplicated content around creating app passwords, etc., into snippets so both credential sets use those snippets for consistency.