add sitemapindex.xml #93
Conversation
orbeckst
commented
Oct 6, 2018
•
orbeckst
commented
- close create sitemapindex.xml #79
- also need to tell algolia search that we have a top level sitemapindex
|
Don't merge yet – wait for #78 to be completed. |
orbeckst
force-pushed
the
issue-78-sitemaps
branch
from
624c1ff to
f63f25f
Compare
|
(And yes, the branch name is wrong, should have been 79...) |
close #79
- [x] MDAnalysis API docs
- [x] User Guide
- [x] PMDA
- [x] GridDataFormats
- [x] MDAnalysisData
- [x] RotamerConvolveMD (not really active but also not dead... let's
call it "mature"...)
orbeckst
force-pushed
the
issue-78-sitemaps
branch
from
f63f25f to
f4ab630
Compare
|
@lilyminium can you please have a look – I am not 100% sure if I am including the sitemaps of the API docs and the User Guide correctly. Thanks. |
- jekyll copies top-level files to the root of the web server - use custom robot.txt (which is NOT overwritten by the jekyll-sitemap plugin) - see jekyll/jekyll-sitemap#88 (comment) for the idea
sitemapindex.xml
Outdated
| <loc>https://www.mdanalysis.org/docs/sitemap.xml</loc> | ||
| </sitemap> | ||
| <sitemap> | ||
| <loc>https://www.mdanalysis.org/UserGuide/sitemap.xml</loc> |
There was a problem hiding this comment.
I'm not sure about this one. This root-level sitemap lists root-level URLs, which just HTTP 301 redirect to the current release version (so https://www.mdanalysis.org/UserGuide/atomgroup.html redirects to https://userguide.mdanalysis.org/1.0.0/atomgroup.html).
There is also a https://userguide.mdanalysis.org/1.0.0/sitemap.xml that has the actual correct URLs for that version of the user guide.
This seems to indicate that you should list the canonical URLs in a sitemap. In that case I should delete the root-level sitemap in the user guide (which also contains its own sitemap_index.xml that points to all the version-level sitemaps).
There was a problem hiding this comment.
I don't primarily think of SEO for the sitemaps but for the algolia site search – that's why the sitemaps are important. I want to avoid having to update the sitemapindex every time so if at all possible, I just want to include "the current released version".
There was a problem hiding this comment.
Sure -- maybe a good compromise would be to re-write UserGuide/sitemap.xml to have the right URLs with each update then (-> 1.0.0).
There was a problem hiding this comment.
Would this sitemap still point to UserGuide/sitemap.xml ?
There was a problem hiding this comment.
For right now I am following your suggestion and use the 1.0.0 path to make sure all our docs are releases.
We can then figure out how to not have to update this sitemaps file constantly.
sitemapindex.xml
Outdated
| xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> | ||
| <sitemap> | ||
| <loc>https://www.mdanalysis.org/docs/sitemap.xml</loc> | ||
| </sitemap> |
There was a problem hiding this comment.
I don't think you have the dev API docs in here.
| </sitemap> | |
| </sitemap> | |
| <sitemap> | |
| <loc>https://docs.mdanalysis.org/1.0.0/sitemap.xml</loc> | |
| </sitemap> | |
| <sitemap> | |
| <loc>https://docs.mdanalysis.org/2.0.0-dev0/sitemap.xml</loc> | |
| </sitemap> |
There was a problem hiding this comment.
On purpose – I think it will be confusing to get two hits for the same question (on our search), especially for normal users who never install develop.
Google will index the dev docs anyway and that's fine but I think we should make an effort to direct users to the docs for the released version.
There was a problem hiding this comment.
Sounds good. I have been meaning to ask (maybe here is not the best place) if you are keen to keep the manually-built www.mdanalysis.org/docs repo+url, or mainly use docs.mdanalysis.org/ for both the release and development docs when the Travis changes are backported to 1.x? If docs.mdanalysis.org is to mainly be the development docs, then that URL should redirect to 2.0.0-dev0, instead of 1.0.0 as it does now.
There was a problem hiding this comment.
I am not keen on manually-anything, the more we automate the better.
The https://www.mdanalysis.org/docs is used widely so I think the best thing would be to have it redirect to the latest stable docs. Is this something we can do?
There was a problem hiding this comment.
For right now I will use https://docs.mdanalysis.org/1.0.0/sitemap.xml and we must update eventually but it would be good to have a stable location such as https://docs.mdanalysis.org/sitemap.xml
