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

Add sitemap index and serve sitemap for subprojects #10629

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

cedk
Copy link
Contributor

@cedk cedk commented Aug 13, 2023

The sitemap index lists all the sitemap locations for a project including the subprojects.
The sitemap of subprojects are also served from the parent domain.

Closes #6841


📚 Documentation previews 📚

@cedk cedk requested review from a team as code owners August 13, 2023 21:37
@cedk cedk requested a review from ericholscher August 13, 2023 21:37
@cedk cedk force-pushed the sitemap-index branch 5 times, most recently from e658d02 to dc4c6fb Compare August 14, 2023 06:52
The sitemap index lists all the sitemap locations for a project
including the subprojects.
The sitemap of subprojects are also served from the parent domain.

Closes readthedocs#6841
@ericholscher
Copy link
Member

Is there any more info on what the sitemap_index is for? I'm not super familiar with this code, but it seems like a nice addition!

@cedk
Copy link
Contributor Author

cedk commented Aug 14, 2023

The sitemap index is a file to list sitemaps of a website: https://en.wikipedia.org/wiki/Sitemaps#File_format
So the idea is that when you use subproject, you want to have a single sitemap file that list all the sitemaps so search engine can discover all the pages.

@cedk
Copy link
Contributor Author

cedk commented Aug 14, 2023

I'm wondering if the robots.txt should refer to the sitemap index instead of the project sitemap. Such that all projects with subproject will gain sitemap discoverability of subproject automatically without having to declare the sitemap index to the search engine.

@cedk
Copy link
Contributor Author

cedk commented Aug 27, 2023

How to relaunch the tests?

@humitos
Copy link
Member

humitos commented Aug 28, 2023

I'm not sure what happened here. Maybe it's a CircleCI configuration that doesn't allow to trigger test on contributor's PRs? 🤷🏼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link to subprojects from sitemap.xml
3 participants