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

Connection management #992

Merged
merged 3 commits into from
Feb 2, 2024
Merged

Connection management #992

merged 3 commits into from
Feb 2, 2024

Conversation

pzaichkina
Copy link
Collaborator

Description

  • Updates to connection management and associated pages

Type of change

Please delete options that are not relevant.

  • New document(s)/updating existing
  • Fixes
  • Styling
  • Bug fix (non-breaking change which fixes an issue)

Copy link

vercel bot commented Feb 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
codat-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 1, 2024 4:17pm

Copy link

github-actions bot commented Feb 1, 2024

Overall readability score: 62.94 (🟢 +0.02)

File Readability
connection-management.md 74.67 (🟢 +3.86)
create-account.md 66.12 (🟢 +0)
companies.md 72.25 (🔴 -1.46)
connections.md 62.14 (🟢 +0.32)
configure-customer.md 3.75 (🟢 +0)
configure-customer.md 52.83 (🟢 +0)
managing-companies.md 63.48 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
connection-management.md 74.67 75.88 11.6 6.5 7.25 7.78
  🟢 +3.86 🟢 +16.89 🔴 -2.77 🟢 +2.3 🟢 +3.35 🔴 -0.7
create-account.md 66.12 48.81 8.46 9.4 11.13 7.71
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
companies.md 72.25 50.12 7.7 8.9 10.31 6.86
  🔴 -1.46 🔴 -8.46 🟢 +0.13 🔴 -0.1 🔴 -0.12 🟢 +0.01
connections.md 62.14 45.46 9.68 12.1 12 6.52
  🟢 +0.32 🟢 +0.21 🟢 +0.25 🔴 -0.1 🔴 -0.11 🟢 +0.05
configure-customer.md 3.75 0 18 20.6 19 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
configure-customer.md 52.83 33.27 6 14.8 16.66 7.49
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
managing-companies.md 63.48 49.48 6 8.4 9.6 11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 62.94 53.14 9.73 10.83 11.42 7.47
  🟢 +0.02 🔴 -0.01 🟢 +0.01 🔴 -0.01 🔴 -0.01 🟢 +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


:::tip
Why this matters
Going forward, your customer should have control over the data they've given you the permission to access. This is key from a regulatory perspective and builds trust between you and your customer.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Going forward, your customer should have control over the data they've given you the permission to access. This is key from a regulatory perspective and builds trust between you and your customer.
Going forward, your customer must have control over the data they've given you the permission to access. This is not only key from a regulatory perspective but ensures trust between you and your customer.

@@ -1,35 +1,55 @@
---
title: "Connection management"
description: "Learn how to enhance the customer journey when a persistent connection is required"
description: "Review our guidance on the best practice of providing your clients with control over their existing connections"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think this should be guidance. We should rephrase is as some like

'Increase trust by putting your customers in control of their data' plus something about it helps to increase adoption through 'trust and transparency' or something.


:::tip Codat's connection management component

Codat is releasing a low-code embeddable UI component for connection management. Please let us know [here](https://forms.gle/d1zuh2iHBLJCNCsj9) if you are interested in using it.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice

@pzaichkina pzaichkina merged commit b5f8fea into main Feb 2, 2024
3 checks passed
@pzaichkina pzaichkina deleted the connection-mgt branch February 2, 2024 12:41
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.

2 participants