Skip to content

docs(en/sitemap.mdx): describe customSitemaps #11563

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
Merged
merged 8 commits into from
Aug 12, 2025
Merged

docs(en/sitemap.mdx): describe customSitemaps #11563

merged 8 commits into from
Aug 12, 2025
+67 −37

Conversation

gouravkhunger
Copy link
Contributor

@gouravkhunger gouravkhunger commented Apr 29, 2025 •
edited by sarah11918
Loading

Description (required)

Add docs for the new customSitemaps option in the @astrojs/sitemap integration.

Related issues & labels (optional)

For @astrojs/sitemap version: 3.5.0 to be released with Astro version: 5.13.0. See astro PR #13682.

First-time contributor to Astro Docs?

Yes, discord: @gouravkhunger

@netlify Netlify
Copy link

netlify bot commented Apr 29, 2025 •
edited
Loading

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 228c7a7
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/689b5a11a03ca600084448fe
😎 Deploy Preview https://deploy-preview-11563--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Apr 29, 2025 •
edited
Loading

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/integrations-guide/sitemap.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@astrobot-houston
Copy link
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) labels Apr 29, 2025
yanthomasdev
yanthomasdev reviewed Jun 17, 2025
View reviewed changes
@gouravkhunger @yanthomasdev
fix: grammar
7d8094b 
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@ematipico ematipico mentioned this pull request Jul 25, 2025
Merged
sarah11918
sarah11918 reviewed Jul 25, 2025
View reviewed changes
src/content/docs/en/guides/integrations-guide/sitemap.mdx
});
```

### customPages
Copy link
Member

Choose a reason for hiding this comment

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

Noting that this content is NOT part of the attached feature PR, but since the new entry was modelled on it, and I didn't exactly love the old one, I've updated both together to match a preferred structure.

Bonus points: if anyone can find when customPages was added, it would be amazing (but not necessary!) to include the since/version for that entry, too.

Copy link
Member

Choose a reason for hiding this comment

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

I found the implementation PR (withastro/astro#3315) but it seems changesets wasn't a thing yet, it's from 2022.

I looked at changelogs (both in sitemap and core) and I can't find anything. It seems it predates Astro v1.0.0! In CHANGELOG-v1.md the oldest PR is around 4225 (while the implementation is 3315). And looking at PRs number in the sitemap changelog, it seems this was implemented around the v0.1.0 of the integration! (4225 is the first PR in 1.0.2 and there is no PR number before that).

So maybe it's fine to omit Since for customPages? 😅

Copy link
Member

Choose a reason for hiding this comment

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

Excellent, thank you for hunting! Yes, our typical M.O. is to only put things that were introduced after v1, so it's fine!

Copy link
Member

Choose a reason for hiding this comment

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

Rereading what I wrote, I noticed I mixed up the numbers between the tabs... 😅 In the sitemap changelog, the implementation PR should be between 0.0.2 and 0.1.1. But the outcomes seem the same, it's old and predates Astro v1!

sarah11918
sarah11918 reviewed Jul 25, 2025
View reviewed changes
ArmandPhilippot
ArmandPhilippot reviewed Jul 25, 2025
View reviewed changes
src/content/docs/en/guides/integrations-guide/sitemap.mdx
});
```

### customPages
Copy link
Member

Choose a reason for hiding this comment

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

I found the implementation PR (withastro/astro#3315) but it seems changesets wasn't a thing yet, it's from 2022.

I looked at changelogs (both in sitemap and core) and I can't find anything. It seems it predates Astro v1.0.0! In CHANGELOG-v1.md the oldest PR is around 4225 (while the implementation is 3315). And looking at PRs number in the sitemap changelog, it seems this was implemented around the v0.1.0 of the integration! (4225 is the first PR in 1.0.2 and there is no PR number before that).

So maybe it's fine to omit Since for customPages? 😅

sarah11918
sarah11918 reviewed Jul 25, 2025
View reviewed changes
sarah11918
sarah11918 approved these changes Aug 1, 2025
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think this one is ready now for when the feature is released! 🎉

@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Aug 1, 2025
@sarah11918 sarah11918 added this to the 5.13.0 milestone Aug 1, 2025
@sarah11918 sarah11918 added the minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! label Aug 1, 2025
bjohansebas
bjohansebas approved these changes Aug 1, 2025
View reviewed changes
Copy link
Contributor

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

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

LGTM

yanthomasdev
yanthomasdev approved these changes Aug 1, 2025
View reviewed changes
Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks.

@sarah11918 sarah11918 changed the base branch from main to 5.13.0 August 12, 2025 15:54
@sarah11918 sarah11918 merged commit 12fc046 into withastro:5.13.0 Aug 12, 2025
10 checks passed
@sarah11918 sarah11918 mentioned this pull request Aug 12, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ArmandPhilippot ArmandPhilippot

@sarah11918 sarah11918

@yanthomasdev yanthomasdev

+1 more reviewer

@bjohansebas bjohansebas

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Milestone
5.13.0
Development

Successfully merging this pull request may close these issues.
7 participants
@gouravkhunger @astrobot-houston @sarah11918 @ArmandPhilippot @yanthomasdev @bjohansebas @ematipico