docs(en/sitemap.mdx): describe customSitemaps
#11563
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
Hello! Thank you for opening your first PR to Astro’s Docs! 🎉 Here’s what will happen next:
|
sarah11918
added
add new content
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
| page !== 'https://example.com/secret-vip-lounge-1/' && | ||
| page !== 'https://example.com/secret-vip-lounge-2/' && | ||
| page !== 'https://example.com/secret-vip-lounge-3/' && | ||
| page !== 'https://example.com/secret-vip-lounge-4/', | ||
| }), | ||
| ], | ||
| }); | ||
| ``` | ||
|
|
||
| ### customPages |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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? 😅
There was a problem hiding this comment.
Excellent, thank you for hunting! Yes, our typical M.O. is to only put things that were introduced after v1, so it's fine!
There was a problem hiding this comment.
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!
| page !== 'https://example.com/secret-vip-lounge-1/' && | ||
| page !== 'https://example.com/secret-vip-lounge-2/' && | ||
| page !== 'https://example.com/secret-vip-lounge-3/' && | ||
| page !== 'https://example.com/secret-vip-lounge-4/', | ||
| }), | ||
| ], | ||
| }); | ||
| ``` | ||
|
|
||
| ### customPages |
There was a problem hiding this comment.
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? 😅
| <Since v="3.5.0" pkg="@astrojs/sitemap" /> | ||
| </p> | ||
|
|
||
| An array of externally sitemaps to be included in the `sitemap-index.xml` file along with the generated sitemap entries. |
There was a problem hiding this comment.
Not a native speaker but externally seems odd here... Should this be external or externally-generated?
There was a problem hiding this comment.
I believe it was supposed to be externally-generated as used in customPages above :)
There was a problem hiding this comment.
Haha, yes, there was some copy/pasting of non-identical things going on here. Thanks for catching!
Description (required)
Add docs for the new
customSitemapsoption in the@astrojs/sitemapintegration.Related issues & labels (optional)
First-time contributor to Astro Docs?
Yes, discord: @gouravkhunger