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.

Sign up for GitHub

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

Jump to bottom

feat(gatsby): content sync debugging tweaks #34487

Merged
merged 3 commits into from
Jan 17, 2022
Merged

feat(gatsby): content sync debugging tweaks #34487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2600ddd
Add verbose instructions and a new env var for node manifest warnings
TylerBarnes Jan 13, 2022
d95eaa0
Add author docs link in conceptual guide
TylerBarnes Jan 13, 2022
f7b7ad3
Merge remote-tracking branch 'upstream/master' into feat/content-sync…
Jan 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/docs/conceptual/content-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,15 @@ The hierarchy is as follows, from most specific to least specific:
3. An `id` property in the [page `context` passed to the `createPage` API][createpage] with a node id which matches the previewed node id. (automatic)
4. The first matching node id found in Gatsby's [GraphQL query tracking][querytracking] which maps node id's to pages that query them. This allows nodes which have no direct top-level page correlated with them to be previewed throughout the site. (automatic)

## Source Plugin Authors

If you're a source plugin author, you can find instructions on adding Content Sync support to your source plugin and CMS extension in the [source plugin author docs](authordocs).

## Diagram

![Diagram of Content Sync on Gatsby Cloud. When a user clicks "Open Preview" the manifest id is created from the CMS and sent to Gatsby Cloud. The Content Sync UI then displays a loading state while it checks for a matching manifest id in Gatsby build public directory. At the same time a request is send to the preview webhook and Gatsby Cloud starts a build. If it finds a matching manifest id created from the CMS Gatsby maps data to correct page for preview and adds the manifest file to the build public directory. Now the Gatsby Cloud Preview Runner detects a node manifest to preview and redirects to the preview itself.](../images/content-sync-diagram.png)

[authordocs]: /docs/how-to/plugins-and-themes/creating-a-source-plugin/#enabling-content-sync
[createnodemanifest]: /docs/reference/config-files/actions#unstable_createNodeManifest
[createpage]: /docs/reference/config-files/actions#createPage
[querytracking]: /docs/page-node-dependencies/
Expand Down
6 changes: 4 additions & 2 deletions packages/gatsby/src/utils/node-manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,9 @@ export async function processNodeManifests(): Promise<Map<
string,
string
> | null> {
const verboseLogs = process.env.gatsby_log_level === `verbose`
const verboseLogs =
process.env.gatsby_log_level === `verbose` ||
process.env.VERBOSE_NODE_MANIFEST === `true`

const startTime = Date.now()
const { nodeManifests } = store.getState()
Expand Down Expand Up @@ -397,7 +399,7 @@ export async function processNodeManifests(): Promise<Map<
...listOfUniqueErrorIds,
].join(`, `)}]. `
: ``) +
`Visit https://gatsby.dev/nodemanifest for more info on Node Manifests`
`To see full warning messages set process.env.VERBOSE_NODE_MANIFEST to "true".\nVisit https://gatsby.dev/nodemanifest for more info on Node Manifests.`
)

// clean up all pending manifests from the store
Expand Down