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

Manually create a sitemap.xml for docs SEO #4261

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

DimedS
Copy link
Contributor

@DimedS DimedS commented Oct 28, 2024

Description

Draft PR currently, checking RTD build

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Dmitry Sorokin <[email protected]>
@DimedS DimedS linked an issue Oct 28, 2024 that may be closed by this pull request
Signed-off-by: Dmitry Sorokin <[email protected]>
@@ -223,6 +223,8 @@
# We've decided to rely on RTD's default robots.txt, so we no longer need to specify a custom one,
# see discussion at https://github.com/kedro-org/kedro/issues/3741
# html_extra_path = [str(here / "robots.txt")]
html_extra_path = [str(here / "sitemap.xml")]
Copy link
Member

Choose a reason for hiding this comment

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

👀 So this was it...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately, I checked the build, and it didn’t help. Something is still overwriting the sitemap.xml, even with that line included.

Signed-off-by: Dmitry Sorokin <[email protected]>
Signed-off-by: Dmitry Sorokin <[email protected]>
@DimedS
Copy link
Contributor Author

DimedS commented Nov 12, 2024

After adding html_extra_path = [str(here / "sitemap.xml")] to conf.py, I observed the following post-build:

I also tried adding a custom robots.txt, but the autogenerated version still appears at https://kedro--4261.org.readthedocs.build/robots.txt. This makes it difficult to verify the effect in this build, and it’s possible that the custom sitemap.xml and robots.txt will only take effect at a later stage, potentially being used at https://docs.kedro.org.

Signed-off-by: Dmitry Sorokin <[email protected]>
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.

Improve SEO and maintenance of documentation versions
2 participants