Skip to content

Broken link to 6.2.0rc1 in the docs #5161

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

Closed
maxrjones opened this issue Apr 20, 2021 · 5 comments · Fixed by #5165 or #5168
Closed

Broken link to 6.2.0rc1 in the docs #5161

maxrjones opened this issue Apr 20, 2021 · 5 comments · Fixed by #5165 or #5168
Assignees
Labels
bug Something isn't working

Comments

@maxrjones
Copy link
Member

Description of the problem

The 'latest' option in the GMT documentation (https://docs.generic-mapping-tools.org/latest/index.html#) correctly links to 6.2.0rc1, but the 6.2rc1 dropdown does not work (https://docs.generic-mapping-tools.org/6.2rc1). I think it is an option to manually fix the links following these methods but with GMT tags (GenericMappingTools/pygmt#1149 (comment)). But, in my opinion it would also be fine to fix as part of the next release candidate.

@maxrjones maxrjones added the bug Something isn't working label Apr 20, 2021
@maxrjones maxrjones linked a pull request Apr 21, 2021 that will close this issue
4 tasks
@seisman
Copy link
Member

seisman commented Apr 21, 2021

The 6.2.0rc1 documentation doesn't show the switch:
image

I think it's because the regex doesn't match the URL of RC releases.

var url_re = new RegExp(doc_url + "\\/(dev|latest|(\\d+\\.\\d+))\\/");

@maxrjones
Copy link
Member Author

The 6.2.0rc1 documentation doesn't show the switch:
image

I think it's because the regex doesn't match the URL of RC releases.

var url_re = new RegExp(doc_url + "\\/(dev|latest|(\\d+\\.\\d+))\\/");

Yes, I agree that this is likely the problem. A secondary problem is that I mistakenly switched the version and title in #5159. Do you think it is better to update the regex to allow for release candidate URLS or to not include a switch for pre-releases?

@seisman
Copy link
Member

seisman commented Apr 21, 2021

I think it's better to update the regex so that people can easily compare any two versions of a single page.

@maxrjones
Copy link
Member Author

I think it's better to update the regex so that people can easily compare any two versions of a single page.

I agree. I can work on this, but I have not been able to get the local testing of the switch to work. Do you have any recommendations for testing locally?

@seisman
Copy link
Member

seisman commented Apr 21, 2021

Do you have any recommendations for testing locally?

There is a detailed instruction in the PyGMT PR: GenericMappingTools/pygmt#621

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
2 participants