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.

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

Manually created sitemap.xml for improved control over indexed docs pages #4145

Merged
merged 5 commits into from
Oct 10, 2024
Merged

Manually created sitemap.xml for improved control over indexed docs pages #4145

merged 5 commits into from
Oct 10, 2024

Conversation

DimedS
Copy link
Member

@DimedS DimedS commented Sep 5, 2024 •
edited
Loading

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

@DmitrySorokinQB
Load manually created sitemap
5ade0c2 
Signed-off-by: Dmitry Sorokin <[email protected]>
@DimedS DimedS linked an issue Sep 5, 2024 that may be closed by this pull request
Improve SEO and maintenance of documentation versions #3741
Open
@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
astrojuanlu
astrojuanlu reviewed Sep 6, 2024
View reviewed changes
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
docs/source/sitemap.xml Outdated
<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
@astrojuanlu astrojuanlu mentioned this pull request Sep 6, 2024
Open
@DimedS DimedS requested a review from astrojuanlu September 6, 2024 13:34
astrojuanlu
astrojuanlu approved these changes Sep 6, 2024
View reviewed changes
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 •
edited
Loading

Thanks a lot @DimedS!

merelcht
merelcht approved these changes Sep 16, 2024
View reviewed changes
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
Closed
2 tasks
@merelcht
Copy link
Member

merelcht commented Oct 8, 2024

@astrojuanlu Does this need any updates before the release?

astrojuanlu
astrojuanlu reviewed Oct 8, 2024
View reviewed changes
docs/source/sitemap.xml
<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-09-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.

These dates have to be put here by hand, but we can try to guesstimate them so they are a bit more realistic @merelcht

Copy link
Member

Choose a reason for hiding this comment

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

@lrcouto might be best if you update this and merge right before the release.

@lrcouto lrcouto merged commit 3a46aba into main Oct 10, 2024
9 checks passed
@lrcouto lrcouto deleted the 3741-improve-docs-seo-manually-create-sitemap branch October 10, 2024 18:33
@merelcht
Copy link
Member

Wait was the date updated in the end or not? @lrcouto @ElenaKhaustova @astrojuanlu

@astrojuanlu
Copy link
Member

More importantly, the sitemap hasn't changed... #3741 (comment)

ankatiyar pushed a commit that referenced this pull request Oct 17, 2024
@DimedS @DmitrySorokinQB
@ElenaKhaustova @lrcouto @ankatiyar
Manually created sitemap.xml for improved control over indexed docs p…
e071640 
…ages (#4145)

* Load manually created sitemap

Signed-off-by: Dmitry Sorokin <[email protected]>

* Add projects remove lastmod for latest

Signed-off-by: Dmitry Sorokin <[email protected]>

* Add latest for projects

Signed-off-by: Dmitry Sorokin <[email protected]>

---------

Signed-off-by: Dmitry Sorokin <[email protected]>
Co-authored-by: Dmitry Sorokin <[email protected]>
Co-authored-by: ElenaKhaustova <[email protected]>
Co-authored-by: L. R. Couto <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
ankatiyar added a commit that referenced this pull request Oct 18, 2024
@ankatiyar
Performance tests for DataCatalog (#4230)
2e950a2 
* Update index.md (#4221)

Fixed an erroneous link to the Get started with Kedro - Create your first data pipeline with Kedro video.  It was accidentally linked to the previous video.

Signed-off-by: Greg Vaslowski <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

* Bump kedro-sphinx-theme from 2024.4.0 to 2024.10.0 (#4216)

* Bump kedro-sphinx-theme from 2024.4.0 to 2024.10.0

Bumps [kedro-sphinx-theme](https://github.com/kedro-org/kedro-sphinx-theme) from 2024.4.0 to 2024.10.0.
- [Release notes](https://github.com/kedro-org/kedro-sphinx-theme/releases)
- [Commits](kedro-org/kedro-sphinx-theme@v2024.4.0...v2024.10.0)

---
updated-dependencies:
- dependency-name: kedro-sphinx-theme
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* updated to 2024.10.2

* trigger_run

* trigger_run

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: L. R. Couto <[email protected]>
Co-authored-by: rashidakanchwala <[email protected]>
Co-authored-by: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

* Replace all instances of "data set" with "dataset" (#4211)

Signed-off-by: Deepyaman Datta <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

* Manually created sitemap.xml for improved control over indexed docs pages (#4145)

* Load manually created sitemap

Signed-off-by: Dmitry Sorokin <[email protected]>

* Add projects remove lastmod for latest

Signed-off-by: Dmitry Sorokin <[email protected]>

* Add latest for projects

Signed-off-by: Dmitry Sorokin <[email protected]>

---------

Signed-off-by: Dmitry Sorokin <[email protected]>
Co-authored-by: Dmitry Sorokin <[email protected]>
Co-authored-by: ElenaKhaustova <[email protected]>
Co-authored-by: L. R. Couto <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

* Bump up version to 0.19.9 (#4219)

* Bump up version to 0.19.9

Signed-off-by: Laura Couto <[email protected]>

* Add placeholders to release.md

Signed-off-by: Laura Couto <[email protected]>

* Update citation.cff release date

Signed-off-by: Laura Couto <[email protected]>

---------

Signed-off-by: Laura Couto <[email protected]>
Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

* first pass doesn't work yet

Signed-off-by: Ankita Katiyar <[email protected]>

* Update ocl tests

Signed-off-by: Ankita Katiyar <[email protected]>

* revert some changes

Signed-off-by: Ankita Katiyar <[email protected]>

* Update to use larger config

Signed-off-by: Ankita Katiyar <[email protected]>

* Update functions and docstrings

Signed-off-by: Ankita Katiyar <[email protected]>

* Add performance tests for DataCatalog

Signed-off-by: Ankita Katiyar <[email protected]>

* Update mypy ignore messages (#4228)

Signed-off-by: Ankita Katiyar <[email protected]>

* Revise Kedro project structure docs (#4208)

* Update project structure docs
---------

Signed-off-by: Dmitry Sorokin <[email protected]>
Signed-off-by: Dmitry Sorokin <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

* Update CLI autocompletion docs with new Click syntax (#4213)

* Update CLI autocompletion docs with new Click syntax

Updated the autocompletion setup instructions for Bash, Zsh, and Fish shells to reflect the latest Click 8.1 syntax. Changed Fish shell completion script path to ~/.config/fish/completions/kedro.fish for correct placement.

Signed-off-by: hyew0nChoi <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

* Bump import-linter from 2.0 to 2.1 (#4226)

Bumps [import-linter](https://github.com/seddonym/import-linter) from 2.0 to 2.1.
- [Changelog](https://github.com/seddonym/import-linter/blob/master/CHANGELOG.rst)
- [Commits](seddonym/import-linter@v2.0...v2.1)

---
updated-dependencies:
- dependency-name: import-linter
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Ankita Katiyar <[email protected]>

* Performance test for `OmegaConfigLoader` (#4225)

* first pass doesn't work yet

Signed-off-by: Ankita Katiyar <[email protected]>

* Update ocl tests

Signed-off-by: Ankita Katiyar <[email protected]>

* revert some changes

Signed-off-by: Ankita Katiyar <[email protected]>

* Update to use larger config

Signed-off-by: Ankita Katiyar <[email protected]>

* Update functions and docstrings

Signed-off-by: Ankita Katiyar <[email protected]>

* lint

Signed-off-by: Ankita Katiyar <[email protected]>

---------

Signed-off-by: Ankita Katiyar <[email protected]>

* Add a test for init and fix indent

Signed-off-by: Ankita Katiyar <[email protected]>

* Revert "Add a test for init and fix indent"

This reverts commit 0dbe3c7.

Signed-off-by: Ankita Katiyar <[email protected]>

* Add a test for init and fix indent

Signed-off-by: Ankita Katiyar <[email protected]>

---------

Signed-off-by: Greg Vaslowski <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Deepyaman Datta <[email protected]>
Signed-off-by: Dmitry Sorokin <[email protected]>
Signed-off-by: Laura Couto <[email protected]>
Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: Dmitry Sorokin <[email protected]>
Signed-off-by: Dmitry Sorokin <[email protected]>
Signed-off-by: hyew0nChoi <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@merelcht merelcht merelcht approved these changes

@astrojuanlu astrojuanlu astrojuanlu approved these changes

@yetudada yetudada Awaiting requested review from yetudada yetudada is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve SEO and maintenance of documentation versions
6 participants
@DimedS @astrojuanlu @merelcht @lrcouto @DmitrySorokinQB @ElenaKhaustova