Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Add troubleshooting guide #919

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Conversation

vinistock
Copy link
Member

Motivation

Closes Shopify/ruby-lsp#1727, closes Shopify/ruby-lsp#1700, closes Shopify/ruby-lsp#1717

Create a troubleshooting guide that includes common issues people might face when starting with the Ruby LSP.

I tried to include the most common source of errors and confusion with a few examples and tips to diagnose the problems.

The idea is for this to be as approachable as possible, even for junior developers. Please let me know if anything is unclear.

@vinistock vinistock added the documentation Improvements or additions to documentation label Nov 27, 2023
@vinistock vinistock self-assigned this Nov 27, 2023
@vinistock vinistock requested a review from a team as a code owner November 27, 2023 21:49
@vinistock vinistock requested review from andyw8 and st0012 November 27, 2023 21:49
Copy link
Member

@st0012 st0012 left a comment

Choose a reason for hiding this comment

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

Overall looks good. It's one of the best troubleshooting guide I've ever seen 🎉
Just a few small suggestions.

TROUBLESHOOTING.md Outdated Show resolved Hide resolved
TROUBLESHOOTING.md Show resolved Hide resolved
TROUBLESHOOTING.md Outdated Show resolved Hide resolved
@vinistock vinistock force-pushed the vs/create_troubleshooting_guide branch from a05437e to c0f4030 Compare November 30, 2023 15:51
Copy link
Contributor

@andyw8 andyw8 left a comment

Choose a reason for hiding this comment

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

I'm wondering some additional tooling to help auto-diagnose issues may be helpful 🤔

(but if switching to bundler-compose solves many of these issues then it may not be worth it).

TROUBLESHOOTING.md Outdated Show resolved Hide resolved
TROUBLESHOOTING.md Outdated Show resolved Hide resolved
TROUBLESHOOTING.md Outdated Show resolved Hide resolved
TROUBLESHOOTING.md Outdated Show resolved Hide resolved
@vinistock vinistock force-pushed the vs/create_troubleshooting_guide branch from c0f4030 to f35058b Compare December 4, 2023 18:52
@vinistock vinistock force-pushed the vs/create_troubleshooting_guide branch from f35058b to 21823f7 Compare December 5, 2023 16:19
@vinistock vinistock requested a review from st0012 December 5, 2023 16:19
@vinistock vinistock merged commit f2670a0 into main Dec 5, 2023
4 checks passed
@vinistock vinistock deleted the vs/create_troubleshooting_guide branch December 5, 2023 16:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants