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.

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

docs: update the outdated generate sitemaps doc with versioned changes #73547

Merged
merged 3 commits into from
Dec 6, 2024

Conversation

huozhi
Copy link
Member

@huozhi huozhi commented Dec 5, 2024

What

The generateSitempasAPI page is outdated, we mentioned this change in the v15 release blog but not super highlighted with examples.

[Breaking] Remove .xml extension for dynamic sitemap routes and align sitemap URLs between development and production

Here we removed the legacy behavior from the description and added a new section of version history at the bottom for users to view and migrate

Unverified

This user has not yet uploaded their public signing key.
@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. Documentation Related to Next.js' official documentation. labels Dec 5, 2024
Copy link
Member Author

huozhi commented Dec 5, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

@huozhi huozhi marked this pull request as ready for review December 5, 2024 11:29
@huozhi huozhi requested review from samcx and delbaoliveira December 5, 2024 11:29
@JamesSingleton
Copy link

Adding here as well that updating the docs here doesn’t fix the issue in that ticket. The issue with that ticket is Next 15 now adds a hash to the URL that is undocumented and will cause things like Google Search Console to no longer find sitemaps that were previously there in Next 14.

While this change does fix that both local and prod sitemap URLs are the same, it doesn’t address the hash issue.

@huozhi
Copy link
Member Author

huozhi commented Dec 5, 2024

@JamesSingleton will address the fix in the separate PR, this PR will only update the docs change!

@huozhi huozhi requested review from ztanner and ijjk December 6, 2024 00:42

Unverified

This user has not yet uploaded their public signing key.
Co-authored-by: Zack Tanner <1939140+ztanner@users.noreply.github.com>
@huozhi huozhi enabled auto-merge (squash) December 6, 2024 10:16
fmt

Unverified

This user has not yet uploaded their public signing key.
@huozhi huozhi merged commit fdd93c1 into canary Dec 6, 2024
53 checks passed
@huozhi huozhi deleted the 12-05-docs_update_legacy_metadata_xml_docs branch December 6, 2024 10:52
devjiwonchoi pushed a commit that referenced this pull request Dec 9, 2024

Unverified

This user has not yet uploaded their public signing key.
#73547)

Co-authored-by: Zack Tanner <1939140+ztanner@users.noreply.github.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Next.js team PRs by the Next.js team. Documentation Related to Next.js' official documentation. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants