DOC-900: Creds overhaul for S

freakwriter commented 2 months ago

Updated all S* credentials to template, except for:

S3: Needs a larger overhaul of both the cred and the app node; I have this logged as more complex, bumped to separate issue: https://linear.app/n8n/issue/DOC-842/review-more-complex-creds-pages
Segment: I believe their API endpoint has been updated and both the terminology and expectations we have here are wrong. Added some more notes about this into the Google Sheet where I'm tracking issues.

Note that this includes renaming sms77 to seven to match what's already in the app, but as the in-app docs link still points to the sms77 URL, I'm not sure if that was correct. I isolated the renaming and URL changes to their own commit in case we need to rollback.

This branch also includes one new snippet to standardize the introductory credential statement we use for credential-only nodes; I'll need to retroactively add that to already-released changes but wanted to get it out there now.

netlify[bot] commented 2 months ago

Deploy Preview for n8n-docs ready!

Name	Link
Latest commit	51da7535f0c9740504a13c1b3b6257e1aff13631
Latest deploy log	https://app.netlify.com/sites/n8n-docs/deploys/66697f8916018e0009429afc
Deploy Preview	https://deploy-preview-2153--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 2 months ago

Overall readability score: 41.91 (🔴 -0.41)

File	Readability
cred-only-statement.md	58.23 (-)
n8n-nodes-base.sms77.md	14.88 (🟢 +0)
salesmate.md	42.64 (🔴 -42.53)
seatable.md	45.41 (🔴 -28.58)
securityscorecard.md	46.11 (🔴 -21)
sekoia.md	32.07 (🔴 -5.64)
sendgrid.md	51.16 (🔴 -38.29)
sendy.md	56.08 (🔴 -20.9)
sentryio.md	42.95 (🔴 -32.59)
serp.md	20.05 (🟢 +11)
servicenow.md	67.38 (🔴 -0.23)
shopify.md	72.92 (🟢 +20.84)
shuffler.md	26.49 (🔴 -7.15)
signl4.md	58.82 (🔴 -30.43)
sms77.md	40.94 (🔴 -47.74)
snowflake.md	40.28 (🔴 -23.87)
splunk.md	46.25 (🔴 -19.08)
spontit.md	67.11 (🔴 -11.94)
spotify.md	36.53 (🔴 -28.15)
ssh.md	86.26 (🟢 +5.59)
stackby.md	43.54 (🔴 -39.59)
storyblok.md	48.85 (🔴 -34.73)
strava.md	50.24 (🔴 -23.98)
stripe.md	74.5 (🔴 -9.73)
supabase.md	54.69 (🔴 -22.84)
surveymonkey.md	74.74 (🔴 -9.25)
syncromsp.md	55.21 (🔴 -14)
credentials.md	44.49 (🔴 -6.83)

View detailed metrics

🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [cred-only-statement.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/_snippets/integrations/builtin/credentials/cred-only-statement.md "_snippets/integrations/builtin/credentials/cred-only-statement.md") | 58.23 | 60.65 | 11.81 | 9.9 | 9.28 | 9.57 | - | - | - | - | - | - [n8n-nodes-base.sms77.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/app-nodes/n8n-nodes-base.sms77.md "docs/integrations/builtin/app-nodes/n8n-nodes-base.sms77.md") | 14.88 | 22.76 | 19 | 22 | 13.48 | 9.96 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [salesmate.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/salesmate.md "docs/integrations/builtin/credentials/salesmate.md") | 42.64 | 21.46 | 9.51 | 14.3 | 16.08 | 8.66 | 🔴 -42.53 | 🔴 -51.07 | 🔴 -3.51 | 🔴 -8.3 | 🔴 -7.55 | 🔴 -1.67 [seatable.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/seatable.md "docs/integrations/builtin/credentials/seatable.md") | 45.41 | 28.09 | 10.14 | 13.7 | 15.57 | 8.3 | 🔴 -28.58 | 🔴 -34.35 | 🔴 -2.91 | 🔴 -6 | 🔴 -5.34 | 🔴 -0.52 [securityscorecard.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/securityscorecard.md "docs/integrations/builtin/credentials/securityscorecard.md") | 46.11 | 12.39 | 8.17 | 15 | 16.38 | 7.38 | 🔴 -21 | 🔴 -33.23 | 🔴 -0.11 | 🔴 -5.7 | 🔴 -4.12 | 🔴 -0.38 [sekoia.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/sekoia.md "docs/integrations/builtin/credentials/sekoia.md") | 32.07 | 12.9 | 10.04 | 16.8 | 17.94 | 9.28 | 🔴 -5.64 | 🔴 -12.35 | 🟢 +2.05 | 🔴 -3.1 | 🔴 -2.76 | 🟢 +0.4 [sendgrid.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/sendgrid.md "docs/integrations/builtin/credentials/sendgrid.md") | 51.16 | 29.21 | 8.15 | 13.7 | 15.04 | 7.86 | 🔴 -38.29 | 🔴 -42.1 | 🔴 -2.15 | 🔴 -7.7 | 🔴 -7.25 | 🔴 -1.94 [sendy.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/sendy.md "docs/integrations/builtin/credentials/sendy.md") | 56.08 | 37.98 | 8.91 | 11.5 | 13.01 | 8.26 | 🔴 -20.9 | 🔴 -23.65 | 🔴 -1.58 | 🔴 -4.2 | 🔴 -3.18 | 🔴 -1.15 [sentryio.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/sentryio.md "docs/integrations/builtin/credentials/sentryio.md") | 42.95 | 19.63 | 7.03 | 17.1 | 18.24 | 7.58 | 🔴 -32.59 | 🔴 -45.38 | 🟢 +0.73 | 🔴 -7.7 | 🔴 -8.33 | 🔴 -1.06 [serp.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/serp.md "docs/integrations/builtin/credentials/serp.md") | 20.05 | 11.38 | 11.51 | 20.7 | 19 | 9.93 | 🟢 +11 | 🟢 +11.38 | 🟢 +2.21 | 🟢 +1.3 | 🟢 +0 | 🟢 +1.07 [servicenow.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/servicenow.md "docs/integrations/builtin/credentials/servicenow.md") | 67.38 | 45.12 | 8.21 | 9.4 | 11.45 | 7.12 | 🔴 -0.23 | 🔴 -8.76 | 🟢 +0.08 | 🔴 -0.4 | 🟢 +0.47 | 🟢 +0.31 [shopify.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/shopify.md "docs/integrations/builtin/credentials/shopify.md") | 72.92 | 45.72 | 6.37 | 9.7 | 11.27 | 6.35 | 🟢 +20.84 | 🟢 +16.61 | 🟢 +0.8 | 🟢 +4.7 | 🟢 +4.53 | 🟢 +1.09 [shuffler.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/shuffler.md "docs/integrations/builtin/credentials/shuffler.md") | 26.49 | 12.49 | 10.01 | 18.3 | 19 | 9.87 | 🔴 -7.15 | 🔴 -12.97 | 🟢 +2.12 | 🔴 -3.7 | 🔴 -2.66 | 🟢 +0.15 [signl4.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/signl4.md "docs/integrations/builtin/credentials/signl4.md") | 58.82 | 53.27 | 8.62 | 11.6 | 13.43 | 8.12 | 🔴 -30.43 | 🔴 -32.83 | 🔴 -2.12 | 🔴 -5.4 | 🔴 -5.33 | 🔴 -1.87 [sms77.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/sms77.md "docs/integrations/builtin/credentials/sms77.md") | 40.94 | 20.75 | 9.53 | 16 | 17.25 | 7.86 | 🔴 -47.74 | 🔴 -59.73 | 🔴 -3.53 | 🔴 -10 | 🔴 -9.64 | 🔴 -1.15 [snowflake.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/snowflake.md "docs/integrations/builtin/credentials/snowflake.md") | 40.28 | 23.83 | 10.34 | 15.9 | 16.81 | 8.03 | 🔴 -23.87 | 🔴 -36.38 | 🔴 -1.8 | 🔴 -4.6 | 🔴 -3.43 | 🔴 -1.01 [splunk.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/splunk.md "docs/integrations/builtin/credentials/splunk.md") | 46.25 | 28.7 | 8.08 | 14.9 | 17.25 | 7.89 | 🔴 -19.08 | 🔴 -26.4 | 🟢 +1.33 | 🔴 -6.8 | 🔴 -6.51 | 🟢 +0.64 [spontit.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/spontit.md "docs/integrations/builtin/credentials/spontit.md") | 67.11 | 46.23 | 8.14 | 9.2 | 10.81 | 7.67 | 🔴 -11.94 | 🔴 -16.11 | 🔴 -1.21 | 🔴 -2.5 | 🔴 -1.85 | 🔴 -0.3 [spotify.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/spotify.md "docs/integrations/builtin/credentials/spotify.md") | 36.53 | 24.14 | 10.32 | 16.7 | 16.86 | 8.84 | 🔴 -28.15 | 🔴 -31.2 | 🟢 +0 | 🔴 -6.4 | 🔴 -6.13 | 🔴 -1.57 [ssh.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/ssh.md "docs/integrations/builtin/credentials/ssh.md") | 86.26 | 70.7 | 6.39 | 6 | 7.57 | 6.77 | 🟢 +5.59 | 🟢 +1.63 | 🔴 -0.04 | 🟢 +1.9 | 🟢 +2.39 | 🔴 -0.23 [stackby.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/stackby.md "docs/integrations/builtin/credentials/stackby.md") | 43.54 | 21.06 | 8.2 | 15.9 | 16.89 | 7.98 | 🔴 -39.59 | 🔴 -48.42 | 🔴 -2.14 | 🔴 -8.7 | 🔴 -7.69 | 🔴 -1.38 [storyblok.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/storyblok.md "docs/integrations/builtin/credentials/storyblok.md") | 48.85 | 27.79 | 8 | 14.5 | 16.33 | 7.66 | 🔴 -34.73 | 🔴 -35.77 | 🔴 -2 | 🔴 -8.1 | 🔴 -7.38 | 🔴 -1 [strava.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/strava.md "docs/integrations/builtin/credentials/strava.md") | 50.24 | 28.3 | 7.78 | 14.6 | 16.09 | 7.43 | 🔴 -23.98 | 🔴 -33.53 | 🔴 -1.17 | 🔴 -5.8 | 🔴 -5.68 | 🟢 +0 [stripe.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/stripe.md "docs/integrations/builtin/credentials/stripe.md") | 74.5 | 59.7 | 7.19 | 9.7 | 10.59 | 6.44 | 🔴 -9.73 | 🔴 -12.83 | 🔴 -1.19 | 🔴 -3.3 | 🔴 -1.53 | 🟢 +0.43 [supabase.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/supabase.md "docs/integrations/builtin/credentials/supabase.md") | 54.69 | 28.5 | 7.3 | 13.9 | 15.22 | 7.01 | 🔴 -22.84 | 🔴 -31 | 🔴 -0.45 | 🔴 -5.3 | 🔴 -4.8 | 🔴 -0.77 [surveymonkey.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/surveymonkey.md "docs/integrations/builtin/credentials/surveymonkey.md") | 74.74 | 53.68 | 6.47 | 9.4 | 11.22 | 6.3 | 🔴 -9.25 | 🔴 -10.08 | 🔴 -0.47 | 🔴 -2.7 | 🔴 -2.16 | 🟢 +0.06 [syncromsp.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/docs/integrations/builtin/credentials/syncromsp.md "docs/integrations/builtin/credentials/syncromsp.md") | 55.21 | 44.1 | 8.96 | 11.9 | 13.37 | 8.48 | 🔴 -14 | 🔴 -15.8 | 🔴 -0.52 | 🔴 -2.4 | 🔴 -1.85 | 🔴 -1.37 [credentials.md](https://github.com/n8n-io/n8n-docs/blob/51da7535f0c9740504a13c1b3b6257e1aff13631/document-templates/credentials.md "document-templates/credentials.md") | 44.49 | 38.62 | 10.79 | 15.2 | 15.14 | 8.29 | 🔴 -6.83 | 🔴 -1.32 | 🔴 -0.48 | 🔴 -2.1 | 🔴 -1.69 | 🔴 -0.11 Averages: | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 41.91 | 34.82 | 12.02 | 15.15 | 14.26 | 8.64 | 🔴 -0.41 | 🔴 -0.53 | 🔴 -0.02 | 🔴 -0.09 | 🔴 -0.08 | 🔴 -0.01

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 2 months ago

@StarfallProjects I've updated to make sure we keep the sms77 file names, but otherwise everything is set up for seven. I think that's the big change I needed to make here before full review, but I'm sure you'll find some other hidden delights...

n8n-io / n8n-docs