-
Notifications
You must be signed in to change notification settings - Fork 89
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
EDU-11993: Improve API extension troubleshooting content #1737
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog 🐶 Line 65 in cded903
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog 🐶 Line 65 in cded903
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog 🐶 Line 65 in cded903
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog 🐶 Line 65 in cded903
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,12 +13,33 @@ Although the FastStore API provides a GraphQL schema for ecommerce, you can exte | |
|
||
Below are different troubleshooting checks and instructions you can use to solve API extension issues: | ||
|
||
- [Debugging API extension issues](#debugging-api-extensions-issues) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog 🐶 |
||
- [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development) | ||
- [Deploy preview/production GraphQL schema different from development](#deploy-previewproduction-graphql-schema-different-from-development) | ||
- [Type generation errors and warnings](#type-generation-errors-and-warnings) | ||
- [Error details](#error-details) | ||
- [GraphQL changes not visible in production/deploy preview](#graphql-changes-not-visible-in-productiondeploy-preview) | ||
|
||
## Debugging API extension issues | ||
|
||
1. Navigate to the `.faststore` folder by running the following in the terminal: | ||
|
||
```bash | ||
cd .faststore | ||
``` | ||
|
||
2. Make sure all dependencies are installed, by running `yarn` in the terminal. | ||
|
||
> ⚠ If you already have dependencies installed in the root folder, you can create a symbolic link to avoid reinstalling them by running the following in the terminal: `ln -s {your-project-path}/{yourrepository.name}/node_modules {your-project-path}/{yourrepository.name}/.faststore`. | ||
> | ||
> If you no longer need the symbolic link, unlink it by running the following in the terminal: `unlink -- {your-project-path}/{yourrepository.name}/node_modules {your-project-path}/{yourrepository.name}/.faststore/node_modules`. | ||
|
||
3. In the terminal, run `yarn generate -d` to provide detailed logs and insights into what might be going wrong. Look for any error messages, warnings, or unexpected behavior in the output. Here's an example of what the debug output might look like: | ||
|
||
 | ||
|
||
Once you have identified the error, check the following sections from this article to fix them. | ||
|
||
## GraphQL changes not visible during development | ||
|
||
If your GraphQL changes aren't visible during development, the changes you have made since you started the development server (`yarn dev`) are probably not optimized. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[markdownlint] reported by reviewdog 🐶
MD046/code-block-style Code block style [Expected: fenced; Actual: indented]
dev-portal-content/docs/troubleshooting/development/issues-during-extending-the-faststore-api-schema.md
Line 49 in cded903