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 created sitemap.xml for improved control over indexed docs pages #4145

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

Conversation

DimedS
Copy link
Contributor

@DimedS DimedS commented Sep 5, 2024

MERGE ONLY BEFORE RELEASE!

Description

Addresses #3741 by manually creating a sitemap.xml file instead of relying on the auto-generated version. This change is intended as a test to determine if it improves our desired outcomes. Depending on the results, we will proceed with the next steps as outlined in this comment.

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 <129520297+DmitrySorokinQB@users.noreply.github.com>
@DimedS DimedS linked an issue Sep 5, 2024 that may be closed by this pull request
@DimedS DimedS marked this pull request as ready for review September 5, 2024 13:55
@DimedS DimedS requested a review from merelcht September 5, 2024 13:55
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

Thanks @DimedS! Left a few comments

docs/source/sitemap.xml Outdated Show resolved Hide resolved
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>https://docs.kedro.org/en/stable/</loc>
<lastmod>2024-08-01T18:53:11.571849+00:00</lastmod>
Copy link
Member

Choose a reason for hiding this comment

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

I'd suggest we keep this PR open and merge it close to the release so we can have a better estimate of this date

docs/source/sitemap.xml Show resolved Hide resolved
Signed-off-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>
Signed-off-by: Dmitry Sorokin <129520297+DmitrySorokinQB@users.noreply.github.com>
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

🤞🏼 and awaiting for the next release...

@astrojuanlu
Copy link
Member

astrojuanlu commented Sep 6, 2024

Thanks a lot @DimedS!

Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

I don't know much about sitemaps, but this looks sensible to me 👍

@merelcht merelcht mentioned this pull request Sep 30, 2024
2 tasks
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
4 participants