Skip to content

sitemap #41

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

shankha013k267
Copy link
Contributor

The generate-sitemap script now automatically updates sitemap.xml. I’ve also added a sitemap section to our site for user navigation, which includes pages that don’t have direct links elsewhere on the website. @kevalpithadiya @mrigankpawagi

sitemap.xml Outdated
Copy link
Member

Choose a reason for hiding this comment

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

You don't need to upload the sitemap to git. It should be automatically generated.

Copy link
Member

Choose a reason for hiding this comment

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

Do we really need this? I don't see how this will be automatically updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, this sitemap.html page is not automatically updated. I added it to help users find pages that don’t have direct navigation links elsewhere on the site. I’ve seen similar user-friendly sitemaps on many websites to improve discoverability.
I’m not sure how useful it will be, but I can explore ways to automate its updates if you think it’s worth keeping.

Copy link
Member

Choose a reason for hiding this comment

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

There must be a way to generate such an HTML file alongside the XML that you are generating.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, there is. But i wanted external links (eg. link to saiman project) also to be included in the sitemap, generating html file alongside the xml will not include these external links. But i'll see if there is a way. I'll update this.

Copy link
Member

Choose a reason for hiding this comment

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

We don't need another CI action. Besides, it will not even work because it is not going to consider generated files at all (?). This functionality is available in Jekyll and should be enabled in the configuration.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback! Just to clarify — since our site isn’t Jekyll-based, we can’t directly use jekyll-sitemap. Were you suggesting we switch to a Jekyll setup, or just pointing to that repo as a reference?
Currently, I have a Node.js script (generate-sitemap.js) that builds sitemap.xml automatically. I can make sure it avoids committing the sitemap to the repo.
Let me know if that sounds good, or if you had a different workflow in mind for non-Jekyll sites :)

Copy link
Member

Choose a reason for hiding this comment

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

Haha sorry -- I forgot we are not using Jekyll. This makes sense.

Copy link
Member

Choose a reason for hiding this comment

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

But yes, it would be good to have a solution that injects the sitemap to GitHub Pages without committing it to the repository.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes sure, i will update this so that it doesn't commit the sitemap to the repo.

@shankha013k267
Copy link
Contributor Author

Added Jekyll configuration to enable automatic sitemap generation

Introduced minimal Jekyll setup (_config.yml and Gemfile) to enable the jekyll-sitemap plugin.

sitemap.xml is now automatically generated in the _site/ directory (which is gitignored).

Tested locally with bundle exec jekyll serve; sitemap generation works as expected.

After deployment, the sitemap will be accessible at:
https://databased.csa.iisc.ac.in/sitemap.xml.

@mrigankpawagi @kevalpithadiya

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.

3 participants