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

docs: Connection Status page updates #39387

Merged
merged 16 commits into from
Jun 11, 2024
Merged

Conversation

nataliekwong
Copy link
Contributor

@nataliekwong nataliekwong commented Jun 11, 2024

What

  • Updates the page to center on Stream Status
  • Updates the image screenshot
  • Reframes the connector error section to be more around troubleshooting

Copy link

vercel bot commented Jun 11, 2024

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

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 11, 2024 4:27am

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jun 11, 2024
Copy link
Contributor

@Adorism Adorism left a comment

Choose a reason for hiding this comment

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

Some comments and suggestions, but this looks very thorough.

| Pending | The connection has not been run yet, so no status exists |
| Status | Description |
| ----------- | --------------------------------------------------------------------------------------------------- |
| **Healthy** | The most recent sync for this connection succeeded |
Copy link
Contributor

Choose a reason for hiding this comment

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

From what I can tell, you can see the per-connection status on the main Connections page and then the per-stream status on the page for a single connection. The description for Healthy here mentions connections and the description for Failed mentions streams, but depending on which view you're looking at either of these statuses could apply to Connections or Streams, is that right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We actually only have a "Healthy" and "Failed" status for Connections, but not Streams. We do more derivation of a status for streams and the closest thing to "Healthy" we have is "On Time" for streams. When a stream fails, it will get categorized into "On Track" , "Late" or "Error" depending on when the user sees it (note: we're planning on moving away from this as it's too complicated logic to understand, but that's what we have today).

Hope that makes sense! I can explain more if that doesn't make sense. You called out correctly that I had a bad "Failed" description here that referred to streams when it should have said connection - just fixed that.

nataliekwong and others added 9 commits June 10, 2024 19:42
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
@nataliekwong nataliekwong merged commit fc781bd into master Jun 11, 2024
27 checks passed
@nataliekwong nataliekwong deleted the natalie/status-updates branch June 11, 2024 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants