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(troubleshooting): Add troubleshooting section to docs #2860

Merged

Conversation

callumhemming
Copy link
Contributor

@callumhemming callumhemming commented May 21, 2024

Description

Relating to issue: #2858 I'm adding a troubleshooting section to the README.md for common issues that pop up during installation and I am adding the issue I came across with some troubleshooting tips to deal with it.

Breaking changes

No

Screenshots

image

Checklist

📌 Always:

  • I have set a clear title
  • My PR is small and contains a single feature
  • I have checked my own PR

👍 Most of the time:

  • I have added or updated test cases
  • I have updated the README if needed

Copy link

netlify bot commented May 21, 2024

Deploy Preview for effervescent-donut-4977b2 failed.

Name Link
🔨 Latest commit dfb32c6
🔍 Latest deploy log https://app.netlify.com/sites/effervescent-donut-4977b2/deploys/66510a91b17525000898eaee

@michaelbromley
Copy link
Member

Thanks! Out of interest which of the solutions worked for you?

@callumhemming
Copy link
Contributor Author

Thanks! Out of interest which of the solutions worked for you?

For me personally (running WSL and using pnpm), the third one(configuring the platform and installing sharp manually) was the only one that worked. In the issues thread users got it working by updating their package manger (yarn) and checking the version of node is supported seems to work best when this issue arises in the sharp repo. I tried a bunch of node version and no difference, I have a feeling using WSL is throwing sharp off when picking the correct binary :)

@michaelbromley
Copy link
Member

OK. I just noticed that the troubleshooting section split the last paragraph of the "migrations" section. Can you rectify that and then it'd good to merge.

@callumhemming
Copy link
Contributor Author

Just pushed a fix :D

@michaelbromley michaelbromley merged commit e61c38d into vendure-ecommerce:master May 31, 2024
12 of 16 checks passed
@michaelbromley
Copy link
Member

Thank you!

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.

None yet

2 participants