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

Link to Troubleshooting doc when Zui shows a connectivity error #2720

Merged
merged 6 commits into from
Mar 17, 2023

Conversation

philrz
Copy link
Contributor

@philrz philrz commented Mar 10, 2023

As described in #1497, we've had a few incidents of users coming to Slack with tricky problems losing connectivity to the local Zed service behind their app. In some cases we've been able to help them figure it out, and some problems have remained a mystery. As a result, we've got a section in the Troubleshooting doc that shares what we know and provides tips, but that still leaves the challenge of making the user aware that the doc exists. This PR attempts to plug that gap by pointing them toward the doc in two places in the app where such a connectivity error occurs.

Demo.mp4

Re-reading that section of the Troubleshooting doc in current times, I recognize conditions have changed slightly since it was first written. When first written, the concept of the app connecting to remote lakes was something we knew was supported by the architecture but 100% of our users were using the app exclusively within their local desktops. Therefore the article was written as if the only reasons these errors could surface would be things like a local Zed service crash, a local firewall or anti-virus tool causing problems, etc. Now that "remote lakes" are something more easily configured in the app and described in its own article (albeit framed as an "advanced" guide) it's easy to see how these connectivity errors could come up in very ordinary circumstances, e.g., during a routine/temporary network outage. That made me slightly nervous that the text as it was written might sent a remote lake user down a rabbit hole of advanced debug when in fact a simple ping would suffice. So what I've included is a small adjustment to the top of that Troubleshooting section to nod toward the article about remote lakes before diving into the local debug details. It's probably not too big of a concern because a user that set up a remote Zed service already has a decent handle on the pieces, and a user connecting to such a remote service is likely to funnel their problems first through the person who's managing the remote Zed service. 🤞

Closes #1497

@philrz philrz requested review from nwt and jameskerr and removed request for nwt and jameskerr March 10, 2023 17:56
@philrz philrz requested review from nwt and jameskerr and removed request for nwt March 10, 2023 18:14
@philrz philrz self-assigned this Mar 10, 2023
Copy link
Member

@nwt nwt left a comment

Choose a reason for hiding this comment

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

Looks good to me but I'll leave approval to @jameskerr.

@philrz philrz merged commit 365b57c into main Mar 17, 2023
@philrz philrz deleted the conn-error-doc-link branch March 17, 2023 21:56
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.

Hyperlink from "Connection Error" screen to Troubleshooting article
3 participants