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

create sitemap.xml for subprojects #78

Closed
7 tasks done
orbeckst opened this issue May 2, 2018 · 2 comments
Closed
7 tasks done

create sitemap.xml for subprojects #78

orbeckst opened this issue May 2, 2018 · 2 comments
Assignees
Labels
search site search, SEO

Comments

@orbeckst
Copy link
Member

orbeckst commented May 2, 2018

For internal search #73 and search engine optimization it would be useful to have sitemaps.org compliant sitemap.xml files. We already automatically generate it for the jekyll site with the jekyll-sitemap plugin. We could automatically generate sitemaps for our sphinx-based content with the sphinx-sitemap plugin for sphinx.

We would then need a top-level sitemapindex.xml file that contains links to all our sitemaps; this sitemapindex.xml would be static and we can just add it to our jekyll site. The sitemap files themselves would be dynamically created (Issue #79).

We currently host (and need) sitemap files for

@orbeckst
Copy link
Member Author

orbeckst commented May 2, 2018

These sitemaps would make all this other content discoverable to the search #73 – at the moment, none of the other subprojects (except the MDAnalysis docs) are linked from anywhere on mdanalysis.org and hence are not included in the Algolia DocSearch index.

orbeckst added a commit to MDAnalysis/pmda that referenced this issue May 6, 2018
orbeckst added a commit to MDAnalysis/mdanalysis that referenced this issue May 6, 2018
- install https://github.com/jdillard/sphinx-sitemap with pip
- create sitemap.xml that is correct for the RELEASE docs
  (it is incorrect for the development docs but we do not want to
  index the devdocs anyway... but we could change it so that by default
  it is correct for devdocs and then we fix sitemap.xml when we manually
  add the release docs with the maintainer/deploy_master_docs.sh script)
- see MDAnalysis/MDAnalysis.github.io#78
orbeckst added a commit to MDAnalysis/pmda that referenced this issue May 7, 2018
orbeckst added a commit to MDAnalysis/mdanalysis that referenced this issue May 7, 2018
- install https://github.com/jdillard/sphinx-sitemap with pip
- create sitemap.xml that is correct for the RELEASE docs
  (it is incorrect for the development docs but we do not want to
  index the devdocs anyway... but we could change it so that by default
  it is correct for devdocs and then we fix sitemap.xml when we manually
  add the release docs with the maintainer/deploy_master_docs.sh script)
- see MDAnalysis/MDAnalysis.github.io#78
@orbeckst orbeckst self-assigned this May 7, 2018
orbeckst added a commit to MDAnalysis/mdanalysis that referenced this issue May 7, 2018
- install https://github.com/jdillard/sphinx-sitemap with pip
- create sitemap.xml that is correct for the RELEASE docs
  (it is incorrect for the development docs but we do not want to
  index the devdocs anyway... but we could change it so that by default
  it is correct for devdocs and then we fix sitemap.xml when we manually
  add the release docs with the maintainer/deploy_master_docs.sh script)
- see MDAnalysis/MDAnalysis.github.io#78
orbeckst added a commit to MDAnalysis/GridDataFormats that referenced this issue May 7, 2018
orbeckst added a commit to MDAnalysis/pytng that referenced this issue May 7, 2018
orbeckst added a commit to MDAnalysis/pytng that referenced this issue May 7, 2018
orbeckst added a commit to MDAnalysis/mdanalysis that referenced this issue May 7, 2018
- install https://github.com/jdillard/sphinx-sitemap with pip
- create sitemap.xml that is correct for the RELEASE docs
  (it is incorrect for the development docs but we do not want to
  index the devdocs anyway... but we could change it so that by default
  it is correct for devdocs and then we fix sitemap.xml when we manually
  add the release docs with the maintainer/deploy_master_docs.sh script)
- see MDAnalysis/MDAnalysis.github.io#78
orbeckst added a commit to MDAnalysis/pmda that referenced this issue May 8, 2018
ayushsuhane pushed a commit to ayushsuhane/mdanalysis that referenced this issue Jun 15, 2018
- install https://github.com/jdillard/sphinx-sitemap with pip
- create sitemap.xml that is correct for the RELEASE docs
  (it is incorrect for the development docs but we do not want to
  index the devdocs anyway... but we could change it so that by default
  it is correct for devdocs and then we fix sitemap.xml when we manually
  add the release docs with the maintainer/deploy_master_docs.sh script)
- see MDAnalysis/MDAnalysis.github.io#78
@orbeckst orbeckst added the search site search, SEO label Jul 17, 2018
orbeckst added a commit that referenced this issue Oct 6, 2018
@orbeckst
Copy link
Member Author

orbeckst commented Jul 8, 2020

All active projects have a sitemap.

@orbeckst orbeckst closed this as completed Jul 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
search site search, SEO
Projects
None yet
Development

No branches or pull requests

1 participant