-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
Add refresh content docs #26106
Merged
laurieontech
merged 5 commits into
gatsbyjs:master
from
herecydev:topics/refreshContentDocs
Aug 18, 2020
Merged
Add refresh content docs #26106
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
4526ce0
Add refresh content docs
herecydev 15b7124
Update docs/docs/refreshing-content.md
herecydev 473f2eb
Update docs/docs/refreshing-content.md
herecydev 7bb9418
Update docs/docs/refreshing-content.md
herecydev 2898802
Update docs/docs/refreshing-content.md
herecydev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Refreshing Content | ||
--- | ||
|
||
During local development it can be useful to refresh sourced content without restarting the development server. To faciliate this Gatsby exposes an environmental variable `ENABLE_GATSBY_REFRESH_ENDPOINT`. | ||
herecydev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If set to true, this will expose a /\_\_refresh webhook that is able to receive POST requests to refresh the sourced content. This exposed webhook can be triggered whenever remote data changes. | ||
herecydev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
You can trigger this endpoint locally, for example, on Unix-based operating systems (like Ubuntu and macOS) using curl -X POST http://localhost:8000/__refresh. | ||
herecydev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Additionally, the sourced content can also be refreshed through the GraphiQL explorer. | ||
herecydev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Securing the refresh endpoint is possible by supplying a value for the environmental variable `GATSBY_REFRESH_TOKEN`, which will cause Gatsby to only accept requests with a matching authorization header. For example `GATSBY_REFRESH_TOKEN=12345` would require a request with header: `authorization: 12345`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
wrong link ...
created PR:
fix(docs): page Environment Variables -> 404 on link