Skip to content

Commit

Permalink
fix(docs): add instructions about installing watchman if necessary in…
Browse files Browse the repository at this point in the history
… the tutorial (#4620)

Summary:
Address issues like #4301 and #4242

Add instructions for installing watchman to the tutorial.

Testing:
<img width="1308" alt="image" src="https://github.com/facebook/relay/assets/3454734/035b07db-30d0-4867-9246-7c400d8af3bf">
<img width="1323" alt="image" src="https://github.com/facebook/relay/assets/3454734/23d0e393-4144-49e5-8b95-9d306a98e033">

Pull Request resolved: #4620

Reviewed By: tyao1

Differential Revision: D54124996

Pulled By: monicatang

fbshipit-source-id: 2bb51eeca2dd7a9c7a937b7aec20bd2c5aca9920
  • Loading branch information
markselby9 authored and facebook-github-bot committed Feb 23, 2024
1 parent 8b3b3fc commit ee03182
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/docs/tutorial/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-v16.0.0/tutorial/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit ee03182

Please sign in to comment.