DOC-842: Overhaul remaining complex credentials

freakwriter commented 1 month ago

Updates these credentials:

AMQP and FTP (delayed until I had a better feel for how these general/non-provider-specific credentials work)
Filemaker: From when I didn't know how to check the codebase to verify which API was being called. #themoreyouknow
LinkedIn: Needed to sift through the differences between the Auth methods and setup a bit more
Generic S3 credential + app node
Automizy: Updated to template even though this service no longer seems to exist
Autopilot: Updated to template but included statement that this wouldn't work with Ortto, added Vale exception for Ortto
Citrix ADC: Had to figure out how to handle the rebrand
Magento 2: Updated to template the best I could
Philips Hue: Made the decision to tell people they didn't need the App ID if they used built-in Cloud OAuth (because you don't) and updated rest to template
Segment: Updated to template since our existing instructions do still seem to work, even though I'm not sure the app node does.

netlify[bot] commented 1 month ago

Deploy Preview for n8n-docs ready!

Name	Link
Latest commit	381a5e371057710b82bbfa59e17d820912c47565
Latest deploy log	https://app.netlify.com/sites/n8n-docs/deploys/6671d3e5e7e23a0008f8754c
Deploy Preview	https://deploy-preview-2171--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.

github-actions[bot] commented 1 month ago

Overall readability score: 41.77 (🔴 -0.15)

File	Readability
n8n-nodes-base.autopilot.md	41.8 (🔴 -1.95)
n8n-nodes-base.s3.md	40.9 (🟢 +16.34)
amqp.md	44.78 (🔴 -19.92)
automizy.md	28.03 (🟢 +6.91)
autopilot.md	34.96 (🔴 -44.09)
citrixadc.md	31.3 (🔴 -36.27)
filemaker.md	47.12 (🔴 -11.87)
ftp.md	72.32 (🟢 +5.71)
linkedin.md	50.74 (🔴 -1.12)
magento2.md	62.46 (🔴 -9.82)
philipshue.md	44.67 (🔴 -36.55)
s3.md	66.13 (🔴 -15.6)
segment.md	62.42 (🔴 -18.09)

View detailed metrics

🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [n8n-nodes-base.autopilot.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/app-nodes/n8n-nodes-base.autopilot.md "docs/integrations/builtin/app-nodes/n8n-nodes-base.autopilot.md") | 41.8 | 34.15 | 13.15 | 15.3 | 13.46 | 8.33 | 🔴 -1.95 | 🔴 -8.87 | 🟢 +0.49 | 🔴 -0.7 | 🔴 -0.58 | 🟢 +0.16 [n8n-nodes-base.s3.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/app-nodes/n8n-nodes-base.s3.md "docs/integrations/builtin/app-nodes/n8n-nodes-base.s3.md") | 40.9 | 46.81 | 14.66 | 16.3 | 11.78 | 8.74 | 🟢 +16.34 | 🟢 +4.43 | 🟢 +4.34 | 🟢 +4.6 | 🔴 -0.98 | 🟢 +0.89 [amqp.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/amqp.md "docs/integrations/builtin/credentials/amqp.md") | 44.78 | 27.59 | 9.88 | 13.3 | 15.34 | 8.89 | 🔴 -19.92 | 🔴 -39.66 | 🔴 -0.08 | 🔴 -4.5 | 🔴 -4.97 | 🟢 +0.1 [automizy.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/automizy.md "docs/integrations/builtin/credentials/automizy.md") | 28.03 | 12.09 | 10.46 | 17.2 | 18.99 | 9.63 | 🟢 +6.91 | 🟢 +11 | 🟢 +0.3 | 🟢 +2.5 | 🟢 +0.01 | 🟢 +0.29 [autopilot.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/autopilot.md "docs/integrations/builtin/credentials/autopilot.md") | 34.96 | 9.65 | 10.15 | 16.8 | 18.48 | 7.92 | 🔴 -44.09 | 🔴 -43.72 | 🔴 -3.66 | 🔴 -9.6 | 🔴 -9 | 🔴 -1.23 [citrixadc.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/citrixadc.md "docs/integrations/builtin/credentials/citrixadc.md") | 31.3 | 20.04 | 10.82 | 16.7 | 18.82 | 9.13 | 🔴 -36.27 | 🔴 -32.52 | 🔴 -2.83 | 🔴 -7.3 | 🔴 -6.55 | 🔴 -1.93 [filemaker.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/filemaker.md "docs/integrations/builtin/credentials/filemaker.md") | 47.12 | 25.56 | 9.62 | 13.7 | 15.24 | 8.06 | 🔴 -11.87 | 🔴 -10.59 | 🔴 -1.62 | 🔴 -2.4 | 🔴 -0.36 | 🔴 -1.04 [ftp.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/ftp.md "docs/integrations/builtin/credentials/ftp.md") | 72.32 | 60.01 | 7.53 | 9.6 | 11.41 | 6.64 | 🟢 +5.71 | 🔴 -3.65 | 🟢 +2.51 | 🔴 -1.4 | 🔴 -0.55 | 🟢 +1.5 [linkedin.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/linkedin.md "docs/integrations/builtin/credentials/linkedin.md") | 50.74 | 26.47 | 7.9 | 14.7 | 16.16 | 7.04 | 🔴 -1.12 | 🔴 -6.84 | 🟢 +0.88 | 🔴 -0.5 | 🔴 -1.21 | 🟢 +0.29 [magento2.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/magento2.md "docs/integrations/builtin/credentials/magento2.md") | 62.46 | 44.3 | 8.24 | 10.5 | 12.33 | 7.71 | 🔴 -9.82 | 🔴 -10.39 | 🔴 -0.79 | 🔴 -2.6 | 🔴 -1.58 | 🔴 -0.23 [philipshue.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/philipshue.md "docs/integrations/builtin/credentials/philipshue.md") | 44.67 | 38.32 | 10.69 | 15.3 | 14.79 | 8.38 | 🔴 -36.55 | 🔴 -29.33 | 🔴 -3.44 | 🔴 -8.3 | 🔴 -5.99 | 🔴 -1.65 [s3.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/s3.md "docs/integrations/builtin/credentials/s3.md") | 66.13 | 46.33 | 7.71 | 10 | 12.08 | 7.29 | 🔴 -15.6 | 🔴 -20.82 | 🔴 -0.77 | 🔴 -2.3 | 🔴 -2.99 | 🔴 -1.02 [segment.md](https://github.com/n8n-io/n8n-docs/blob/381a5e371057710b82bbfa59e17d820912c47565/docs/integrations/builtin/credentials/segment.md "docs/integrations/builtin/credentials/segment.md") | 62.42 | 45.52 | 7.5 | 12 | 13.54 | 6.97 | 🔴 -18.09 | 🔴 -27.31 | 🔴 -1.5 | 🔴 -4.9 | 🔴 -3.67 | 🟢 +0.4 Averages: | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 41.77 | 34.62 | 12.02 | 15.19 | 14.3 | 8.65 | 🔴 -0.15 | 🔴 -0.19 | 🔴 -0.01 | 🔴 -0.03 | 🔴 -0.03 | 🟢 +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

@Joffcom would you be able to review the changes to docs/integrations/builtin/credentials/linkedin.md? I think I've captured the broad strokes of your comments in this forum thread and this PR but this still feels like I could be providing better guidance/more detail about when to use each auth type and other tricks/gotchas about setting them up. I'd appreciate any insight or feedback you might have on how to make this better!

freakwriter commented 4 weeks ago

@StarfallProjects This includes anything that I had marked as more complex and needed to return to, as well as the creds I initially skipped due to complexity or issues. I've at least updated everything to template and tried to add statements about known limitations, etc. This one might be a trickier review but it's the last of the initial credentials updates!

n8n-io / n8n-docs