Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-875: Creds overhaul for O-R #2144

Merged
merged 17 commits into from
Jun 6, 2024
Merged

DOC-875: Creds overhaul for O-R #2144

merged 17 commits into from
Jun 6, 2024

Conversation

freakwriter
Copy link
Contributor

Creds overhaul for all credentials beginning with the letters O, P, Q, and R except for:

  • Philips Hue (there's some funkiness with this one, as noted in my tracking spreadsheet)

Copy link

netlify bot commented Jun 4, 2024

Deploy Preview for n8n-docs ready!

Name Link
🔨 Latest commit 9c099ae
🔍 Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/6661bf0f6b994b00086f65c3
😎 Deploy Preview https://deploy-preview-2144--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.

Copy link

github-actions bot commented Jun 4, 2024

Overall readability score: 42.33 (🔴 -0.46)

File Readability
odoo.md 62.16 (🔴 -16.33)
okta.md 69.05 (🟢 +30.82)
onesimpleapi.md 60.15 (🔴 -30.61)
onfleet.md 47.67 (🔴 -30.06)
opencti.md 42.46 (🟢 +4.37)
openweathermap.md 43.58 (🔴 -28.77)
orbit.md 56.77 (🔴 -29.27)
oura.md 35.86 (🔴 -45.73)
paddle.md 60.76 (🔴 -12.4)
pagerduty.md 40.07 (🔴 -34.57)
paypal.md 58.61 (🔴 -28.02)
peekalink.md 47.51 (🔴 -28.34)
phantombuster.md 48.35 (🔴 -30.88)
pinecone.md 25.85 (🟢 +19.18)
pipedrive.md 57.1 (🟢 +28.42)
plivo.md 56.2 (🔴 -27.65)
postgres.md 76.04 (🟢 +31.32)
posthog.md 64.48 (🔴 -17.62)
postmark.md 42.94 (🔴 -37.45)
profitwell.md 40.15 (🔴 -34.81)
pushbullet.md 62.74 (🔴 -6.73)
pushcut.md 46.62 (🔴 -31.94)
pushover.md 16.92 (🔴 -64.49)
qdrant.md 28.2 (🟢 +14.46)
qradar.md 46.37 (🟢 +6.15)
qualys.md 49.67 (🟢 +16.28)
questdb.md 56.47 (🟢 +2.43)
quickbase.md 41.62 (🔴 -45.76)
quickbooks.md 54.92 (🔴 -25.36)
rabbitmq.md 77.09 (🟢 +14.33)
raindrop.md 57.97 (🔴 -25.71)
recordedfuture.md 47.55 (🟢 +12.22)
reddit.md 53.48 (🔴 -29.07)
redis.md 63.38 (🟢 +3.09)
rocketchat.md 56.15 (🔴 -20.48)
rundeck.md 57.65 (🔴 -23.94)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
odoo.md 62.16 44.1 8.23 11.1 12.21 7.58
  🔴 -16.33 🔴 -18.04 🔴 -0.78 🔴 -4.4 🔴 -3.6 🔴 -0.17
okta.md 69.05 52.26 7.57 9.2 10.42 7.85
  🟢 +30.82 🟢 +18.55 🟢 +3.87 🟢 +4.6 🟢 +4.88 🟢 +2.35
onesimpleapi.md 60.15 36.96 8.6 10.5 12.44 7.81
  🔴 -30.61 🔴 -34.75 🔴 -2.6 🔴 -4.5 🔴 -6.1 🔴 -1.64
onfleet.md 47.67 28.7 9.23 13.5 15.74 8.13
  🔴 -30.06 🔴 -32.93 🔴 -2.11 🔴 -6.1 🔴 -6.08 🔴 -1.11
opencti.md 42.46 20.04 9.82 14.1 15.92 8.64
  🟢 +4.37 🔴 -5.42 🟢 +2.31 🔴 -0.4 🔴 -0.62 🟢 +0.86
openweathermap.md 43.58 27.89 9.21 14.9 16.62 8.35
  🔴 -28.77 🔴 -25.79 🔴 -1.89 🔴 -6.1 🔴 -4.99 🔴 -1.67
orbit.md 56.77 28.5 6.19 13.3 15.05 7.3
  🔴 -29.27 🔴 -43.01 🔴 -0.19 🔴 -7.3 🔴 -7.03 🔴 -0.41
oura.md 35.86 18.92 10.24 16 17.61 8.81
  🔴 -45.73 🔴 -40.68 🔴 -3.85 🔴 -8.2 🔴 -8.06 🔴 -2.84
paddle.md 60.76 43.59 7.76 12.2 13.67 7.1
  🔴 -12.4 🔴 -17.33 🔴 -0.71 🔴 -4.1 🔴 -3.2 🟢 +0.67
pagerduty.md 40.07 17.2 9.89 15.7 17.21 7.91
  🔴 -34.57 🔴 -40.57 🔴 -1.7 🔴 -6.8 🔴 -7.18 🔴 -1.54
paypal.md 58.61 38.08 8.21 11.4 13.12 7.85
  🔴 -28.02 🔴 -33.13 🔴 -2.21 🔴 -5.3 🔴 -4.81 🔴 -1.33
peekalink.md 47.51 28.09 8.61 14.9 16.09 7.69
  🔴 -28.34 🔴 -32.93 🔴 -1.56 🔴 -6.5 🔴 -5.27 🔴 -1.04
phantombuster.md 48.35 27.89 8.62 14.9 16.1 7.41
  🔴 -30.88 🔴 -34.75 🔴 -2.62 🔴 -6.9 🔴 -5.23 🔴 -1.01
pinecone.md 25.85 1.8 9.97 20 19 8.77
  🟢 +19.18 🟢 +1.8 🟢 +5.14 🟢 +2 🟢 +0 🟢 +2.23
pipedrive.md 57.1 35.84 8.44 12.7 14.18 7.03
  🟢 +28.42 🟢 +27.51 🟢 +1.69 🟢 +6.2 🟢 +4.82 🟢 +1.61
plivo.md 56.2 38.18 7.77 13.1 14.4 7.51
  🔴 -27.65 🔴 -30.89 🔴 -1.62 🔴 -5.9 🔴 -5.02 🔴 -1.28
postgres.md 76.04 52.56 6.2 9.3 11.05 6.1
  🟢 +31.32 🟢 +14.96 🟢 +3.68 🟢 +6 🟢 +4.9 🟢 +2.15
posthog.md 64.48 44.51 6.91 11.1 13.08 7.2
  🔴 -17.62 🔴 -24.06 🔴 -0.48 🔴 -3.8 🔴 -3.88 🔴 -0.57
postmark.md 42.94 27.18 9 15 16.62 8.58
  🔴 -37.45 🔴 -41.89 🔴 -3 🔴 -7.4 🔴 -6.55 🔴 -1.68
profitwell.md 40.15 28.8 11.17 13.9 15.8 9.23
  🔴 -34.81 🔴 -34.45 🔴 -5.12 🔴 -5.8 🔴 -4.82 🔴 -1.59
pushbullet.md 62.74 43.49 8.57 10.8 12.51 7.19
  🔴 -6.73 🔴 -15.3 🔴 -0.37 🔴 -1.1 🔴 -1.33 🔴 -0.03
pushcut.md 46.62 29.21 9.53 14.1 15.56 8.13
  🔴 -31.94 🔴 -34.45 🔴 -2.75 🔴 -7.2 🔴 -5.8 🔴 -0.9
pushover.md 16.92 0 13.61 20.3 19 9.38
  🔴 -64.49 🔴 -61.02 🔴 -7.05 🔴 -12.9 🔴 -9.63 🔴 -3.11
qdrant.md 28.2 12.7 9.36 20.5 19 8.7
  🟢 +14.46 🟢 +3.15 🟢 +3.22 🟢 +1.5 🟢 +0 🟢 +1.94
qradar.md 46.37 28.5 9.26 13.2 15.22 8.87
  🟢 +6.15 🔴 -5.21 🟢 +2.18 🟢 +0.5 🔴 -0.04 🟢 +0.81
qualys.md 49.67 36.45 9.27 12.4 14.12 9.09
  🟢 +16.28 🟢 +11.2 🟢 +2.82 🟢 +2.1 🟢 +2.11 🟢 +1.11
questdb.md 56.47 44.3 9.11 12.1 13.89 7.7
  🟢 +2.43 🔴 -0.82 🟢 +0.02 🟢 +0.5 🟢 +2.67 🔴 -0.61
quickbase.md 41.62 35.84 10.95 13.8 15.11 9.6
  🔴 -45.76 🔴 -43.22 🔴 -4.95 🔴 -7.8 🔴 -7.43 🔴 -2.59
quickbooks.md 54.92 35.34 8 13.6 15.23 7.05
  🔴 -25.36 🔴 -33.84 🔴 -1.4 🔴 -5.6 🔴 -4.93 🔴 -0.71
rabbitmq.md 77.09 62.24 6.87 8.1 10.18 6.84
  🟢 +14.33 🔴 -5.82 🟢 +2.38 🟢 +1.9 🟢 +1.69 🟢 +1.89
raindrop.md 57.97 43.29 9.24 11.3 12.74 7.98
  🔴 -25.71 🔴 -26.19 🔴 -2.64 🔴 -4.1 🔴 -3.6 🔴 -1.81
recordedfuture.md 47.55 27.69 8 13.8 15.75 8.63
  🟢 +12.22 🟢 +2.84 🟢 +3.39 🟢 +0.7 🟢 +0.3 🟢 +1.4
reddit.md 53.48 41.56 10.23 12.2 12.86 8.3
  🔴 -29.07 🔴 -26.7 🔴 -3.17 🔴 -5.1 🔴 -4.41 🔴 -1.74
redis.md 63.38 47.04 8.01 10.7 12.48 7.53
  🟢 +3.09 🟢 +2.63 🔴 -0.01 🟢 +0 🟢 +1.53 🟢 +0.16
rocketchat.md 56.15 38.38 7.53 12.3 14.46 8
  🔴 -20.48 🔴 -22.95 🔴 -0.33 🔴 -5 🔴 -5.03 🔴 -0.55
rundeck.md 57.65 36.96 8.04 11.3 12.79 8.37
  🔴 -23.94 🔴 -33.54 🔴 -1.86 🔴 -5.1 🔴 -4.64 🔴 -0.39

Averages:

  Readability FRE GF ARI CLI DCRS
Average 42.33 35.35 12.01 15.05 14.18 8.63
  🔴 -0.46 🔴 -0.63 🔴 -0.02 🔴 -0.1 🔴 -0.09 🔴 -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
Copy link
Contributor Author

@StarfallProjects I think this one is now ready for review. One thing of note:

I did update the Paddle cred, but it also looked to me like they've made some major updates to their API (no longer requiring a vendor ID, among other things). Paddle calls the two APIs different things (Paddle Classic is the old; Paddle Billing is the new). I noted this change in my tracking spreadsheet but I wanted to call it out here so you could review how I handled it in the creds node and see if you wanted any changes made.

@Joffcom
Copy link
Member

Joffcom commented Jun 5, 2024

@freakwriter at the moment we only support Paddle Classic, it is a nice reminder that we should probably update the node to support the new Paddle api as well.

Copy link
Contributor

@StarfallProjects StarfallProjects left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we're basically there, but had a couple of questions to clarify. See inline comments.

@StarfallProjects StarfallProjects merged commit 8ab2ed9 into main Jun 6, 2024
6 of 7 checks passed
@StarfallProjects StarfallProjects deleted the DOC-875 branch June 6, 2024 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants