From ee03182fa05430690f3b33dfff5d3426e49fd8dc Mon Sep 17 00:00:00 2001 From: Mark Feng Date: Fri, 23 Feb 2024 15:56:33 -0800 Subject: [PATCH] fix(docs): add instructions about installing watchman if necessary in the tutorial (#4620) Summary: Address issues like https://github.com/facebook/relay/issues/4301 and https://github.com/facebook/relay/issues/4242 Add instructions for installing watchman to the tutorial. Testing: image image Pull Request resolved: https://github.com/facebook/relay/pull/4620 Reviewed By: tyao1 Differential Revision: D54124996 Pulled By: monicatang fbshipit-source-id: 2bb51eeca2dd7a9c7a937b7aec20bd2c5aca9920 --- website/docs/tutorial/intro.md | 2 ++ website/versioned_docs/version-v16.0.0/tutorial/intro.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/website/docs/tutorial/intro.md b/website/docs/tutorial/intro.md index 12c8cf4ed3ef4..633956e930565 100644 --- a/website/docs/tutorial/intro.md +++ b/website/docs/tutorial/intro.md @@ -36,6 +36,8 @@ When you run `npm run dev`, several processes are started: In the terminal output, these three processes’ log output are marked with tags: `[webpack]` in yellow, `[server]` in green, and `[relay]` in blue. Keep a look out for errors marked with `[relay]` as these are helpful if your GraphQL has any mistakes. +If you encounter errors in the `[relay]` process indicating: ```[relay] thread 'main' panicked at 'Cannot run relay in watch mode if `watchman` is not available (or explicitly disabled).'```, this means watchman is not installed or available on your system. To resolve this, you may need to [install watchman separately](https://facebook.github.io/watchman/docs/install). After installing watchman, try running `npm run dev` again. + Now that these processes are running, you should be able to open [http://localhost:3000](http://localhost:3000/) in your browser. ![Screenshot](/img/docs/tutorial/intro-screenshot-placeholder.png) diff --git a/website/versioned_docs/version-v16.0.0/tutorial/intro.md b/website/versioned_docs/version-v16.0.0/tutorial/intro.md index 12c8cf4ed3ef4..633956e930565 100644 --- a/website/versioned_docs/version-v16.0.0/tutorial/intro.md +++ b/website/versioned_docs/version-v16.0.0/tutorial/intro.md @@ -36,6 +36,8 @@ When you run `npm run dev`, several processes are started: In the terminal output, these three processes’ log output are marked with tags: `[webpack]` in yellow, `[server]` in green, and `[relay]` in blue. Keep a look out for errors marked with `[relay]` as these are helpful if your GraphQL has any mistakes. +If you encounter errors in the `[relay]` process indicating: ```[relay] thread 'main' panicked at 'Cannot run relay in watch mode if `watchman` is not available (or explicitly disabled).'```, this means watchman is not installed or available on your system. To resolve this, you may need to [install watchman separately](https://facebook.github.io/watchman/docs/install). After installing watchman, try running `npm run dev` again. + Now that these processes are running, you should be able to open [http://localhost:3000](http://localhost:3000/) in your browser. ![Screenshot](/img/docs/tutorial/intro-screenshot-placeholder.png)