Skip to content

Stale version of docs at Read The Docs #431

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
chrish42 opened this issue Apr 28, 2021 · 19 comments
Closed

Stale version of docs at Read The Docs #431

chrish42 opened this issue Apr 28, 2021 · 19 comments

Comments

@chrish42
Copy link

Hi. This seemed like the best place to file this issue. There's a stale version of the numpy docs at https://numpy.readthedocs.io/en/latest/.

I feel either deleting it or setting up a redirect to numpy.org/doc would be more than good enough. Either would avoid people using a version of the docs that's not updated anymore, at least.

@rgommers
Copy link
Member

Thanks for the report @chrish42.

@shoyer the RTD setup was pointing at your fork rather than the main repo. I changed that now.

I don't want to delete the whole project, because then someone else can take over the numpy name on RTD I think. But we also don't want to maintain it. Anyone know of any solutions? @astrojuanlu maybe?

@shoyer
Copy link
Member

shoyer commented Apr 28, 2021

I asked over in the RTD support issues: readthedocs/readthedocs.org#8143

@astrojuanlu
Copy link

Hah, I was writing a response at the same time you opened the issue upstream :) let's continue the discussion there

@InessaPawson
Copy link
Member

RTD doesn’t seem to offer new solutions for taking care of this issue. Should we add an index as suggested here: readthedocs/readthedocs.org#8143 (comment)?

@mattip
Copy link
Member

mattip commented Dec 28, 2021

According to the numpy project page the maintainers on ReadTheDocs are @rgommers, @shoyer, and @wolph. If someone else wants to pick this up, one of the maintainers will need to give them the needed permissions. Any volunteers?

@mattip mattip changed the title Stale version of docs at Read The Docs DOC: Stale version of docs at Read The Docs Dec 28, 2021
@mattip mattip changed the title DOC: Stale version of docs at Read The Docs Stale version of docs at Read The Docs Dec 28, 2021
@wolph
Copy link

wolph commented Dec 28, 2021

I can give permission, just tell me the username. I only created the project on read the docs many years ago in the hopes of having up to date docs available. But I couldn't get it to build at that time.

I'm not sure about the current state though.

@shoyer
Copy link
Member

shoyer commented Dec 28, 2021 via email

@wolph
Copy link

wolph commented Dec 28, 2021

How about a little stub documentation that (automatically) redirects you to the numpy docs?

@shoyer
Copy link
Member

shoyer commented Dec 28, 2021 via email

@shaloo
Copy link
Contributor

shaloo commented Dec 31, 2021

I can take that up. Can you give me permissions on RTD project for NumPy so that I can create a stub that redirects to official NumPy docs page?

@rgommers
Copy link
Member

Thanks @shaloo! Is your ReadTheDocs username also shaloo? If you don't have an account there yet, you'll need to create one.

@shaloo
Copy link
Contributor

shaloo commented Dec 31, 2021

@rgommers, @mattip here is the draft setup at RTD - please take a look and let me know if there are any suggestions. I have used the default RTD theme, easier to setup/build and deploy for a single page redirect. https://numpy.readthedocs.io/en/latest/

Also, for now I have used a public git repo (https://github.com/shaloo/numpydoc-redirect) that RTD points to in order to generate this page. If you'd like me to keep it under NumPy - or transfer it as a sub project of NumPy, pls guide on how to move it / access etc.

@rgommers
Copy link
Member

That looks great, thanks @shaloo!

Also, for now I have used a public git repo (https://github.com/shaloo/numpydoc-redirect) that RTD points to in order to generate this page. If you'd like me to keep it under NumPy - or transfer it as a sub project of NumPy, pls guide on how to move it / access etc.

It's probably a good idea to transfer that repo indeed. Hopefully we'll never have to update it, but I can image that we'd want to in the far future, and that we then can't find the link anymore.

If you go to https://github.com/shaloo/numpydoc-redirect/settings, then at the bottom of that page you should see "Transfer ownership". If that doesn't work because you don't have enough permissions on the NumPy org, can you give me admin rights on your repo (use "Manage access" in Settings)? Then I can move it.

@shaloo
Copy link
Contributor

shaloo commented Jan 1, 2022

I tried to transfer ownership but it did not allow me to do move it to NumPy.org. Adding @rgommers as admin to do the needful.

@rgommers
Copy link
Member

rgommers commented Jan 1, 2022

Ah, that wasn't quite enough @shaloo - it needs to be Admin permissions, not Write or Maintain.

@shaloo
Copy link
Contributor

shaloo commented Jan 1, 2022

I do not see any option for 'Role' or editing permissions. When I added you as a collaborator to the repo - it just sent the default invite - I am not sure how to add you as an admin - looked around in settings but can't seem to find any option. Let me try transferring the repo to you as a user and not NumPy.orgScreenshot 2022-01-01 at 4 29 56 PM

@shaloo
Copy link
Contributor

shaloo commented Jan 1, 2022

Transferred to @rgommers. Can you access it now?Screenshot 2022-01-01 at 4 33 51 PM

@rgommers
Copy link
Member

rgommers commented Jan 1, 2022

Done: https://github.com/numpy/numpy-readthedocs-redirect

Thanks @shaloo! I think we're good here, let's close this issue.

@rgommers rgommers closed this as completed Jan 1, 2022
@shaloo
Copy link
Contributor

shaloo commented Jan 2, 2022

After moving NumPy-readthedocs-redirect, we also need to update RTD Repository URL from

https://github.com/shaloo/numpydoc-redirect.git

to

https://github.com/numpy/numpy-readthedocs-redirect

Done, now :-)

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

No branches or pull requests

8 participants