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

chore(docs): note cache-control header for preview/draft mode #53825

Merged
merged 3 commits into from Aug 10, 2023
Merged

chore(docs): note cache-control header for preview/draft mode #53825

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
7322d3a
chore(docs): note cache-control header for preview/draft mode
styfle Aug 9, 2023
0a8680c
Apply suggestions from code review
styfle Aug 10, 2023
225a788
Merge branch 'canary' into fix-docs-getserversideprops-draft-mode
styfle Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/03-pages/01-building-your-application/06-configuring/11-draft-mode.mdx
View file
Open in desktop
Expand Up @@ -156,7 +156,9 @@ Then, send a request to `/api/disable-draft` to invoke the API Route. If calling

### Works with `getServerSideProps`

Draft Mode works with `getServerSideProps` as well. It will also be available on the `context` object containing `draftMode`
Draft Mode works with `getServerSideProps`, and is available as a `draftMode` key in the [`context`](/docs/pages/api-reference/functions/get-server-side-props#context-parameter) object.

> **Good to know**: You shouldn't set the `Cache-Control` header when using Draft Mode because it cannot be bypassed. Instead, we recommend using [ISR](/docs/pages/building-your-application/data-fetching/incremental-static-regeneration).

### Works with API Routes

Expand Down
2 changes: 2 additions & 0 deletions docs/03-pages/01-building-your-application/06-configuring/14-preview-mode.mdx
View file
Open in desktop
Expand Up @@ -219,6 +219,8 @@ You can pass an object to `setPreviewData` and have it be available in `getStati

The preview mode works on `getServerSideProps` as well. It will also be available on the `context` object containing `preview` and `previewData`.

> **Good to know**: You shouldn't set the `Cache-Control` header when using Preview Mode because it cannot be bypassed. Instead, we recommend using [ISR](/docs/pages/building-your-application/data-fetching/incremental-static-regeneration).

### Works with API Routes

API Routes will have access to `preview` and `previewData` under the request object. For example:
Expand Down