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

Add clarity in docs for using exportPathMap with getStaticPaths #39813

Merged
merged 2 commits into from Aug 22, 2022
Merged

Add clarity in docs for using exportPathMap with getStaticPaths #39813

merged 2 commits into from Aug 22, 2022

Conversation

MaedahBatool
Copy link
Contributor

This PR adds a warning note for using the exportPathMap function with getStaticPaths. Any routes defined with EPM will get overridden if that page uses GSP.

Bug

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running pnpm lint
  • The examples guidelines are followed from our contributing doc

@MaedahBatool MaedahBatool self-assigned this Aug 22, 2022
@ijjk ijjk merged commit e307096 into vercel:canary Aug 22, 2022
leerob
leerob reviewed Aug 23, 2022
View reviewed changes
docs/api-reference/next.config.js/exportPathMap.md
@@ -79,6 +79,8 @@ module.exports = {
next export -o outdir
```

> **Warning**: Using `exportPathMap` for defining routes with any `getStaticPaths` powered page is now ignored and gets overridden. We recommend not to use them together.
Copy link
Member

@leerob leerob Aug 23, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"is now ignored" – what changed and at what version? If we don't recommend to use together, can we provide more clarity?

Note: If you are using getStaticPaths to define routes, you should not use exportPathMap.

Is it this or something else?

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@leerob leerob leerob left review comments

@ijjk ijjk ijjk approved these changes

@timneutkens timneutkens Awaiting requested review from timneutkens

@shuding shuding Awaiting requested review from shuding

@styfle styfle Awaiting requested review from styfle

@huozhi huozhi Awaiting requested review from huozhi

@padmaia padmaia Awaiting requested review from padmaia

@balazsorban44 balazsorban44 Awaiting requested review from balazsorban44

@molebox molebox Awaiting requested review from molebox

Assignees

@MaedahBatool MaedahBatool

Labels
created-by: Next.js docs team PRs by the Next.js docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@MaedahBatool @leerob @ijjk