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

Use readthedocs? #128

Closed
choldgraf opened this issue Jun 25, 2020 · 10 comments · Fixed by #297
Closed

Use readthedocs? #128

choldgraf opened this issue Jun 25, 2020 · 10 comments · Fixed by #297

Comments

@choldgraf
Copy link
Member

Maybe this is just me being whiny, but I find it difficult to remember the URL of this repository since it's a sub-domain of the jupyterhub github.io page. I'd find nbgitpuller.readthedocs.io easier to remember, since it follows the same pattern that many other orgs do. With jupyterhub.github.io/nbgitpuller I have to remember things like "is nbgitpuller in jupyter/ or jupyterhub/". Would anybody be opposed to using RTD for the docs?

@yuvipanda
Copy link
Contributor

yuvipanda commented Jun 25, 2020

I always use https://nbgitpuller.link ;)

@yuvipanda
Copy link
Contributor

Would links break? IIRC that's why we didn't do it last time, and that's why I bought nbgitpuller.link...

@choldgraf
Copy link
Member Author

oh yeah, I forgot about that URL!

ah pre-existing links you mean...maybe. I guess we could set up sphinx re-directs? How many links to the docs are there out there?

@manics
Copy link
Member

manics commented Jun 25, 2020

I've got no objections. Though

Maybe this is just me being whiny, but I find it difficult to remember the URL of this repository

is slightly concerning- if you have to remember it instead of clicking on a link somewhere obvious does that mean it's not prominent enough?

@choldgraf
Copy link
Member Author

choldgraf commented Jun 25, 2020

I think my perspective would be reflective of "somebody that uses readthedocs a lot, and knows that nbgitpuller exists, but doesn't have the docs URL memorized". So I default to assuming a project docs are at <projectname>.readthedocs.io and in this case that is a false assumption so I have to google it

@manics
Copy link
Member

manics commented Oct 3, 2020

Is there a decision here? Do people want to move to RTD (and it's a matter of finding time to do it) or is everyone happy with the current URLs?

@choldgraf
Copy link
Member Author

I'm a fan of readthedocs :-)

@manics
Copy link
Member

manics commented Oct 3, 2020

If it helps you can setup redirects in RTD instead of doing it in Sphinx https://docs.readthedocs.io/en/stable/user-defined-redirects.html#prefix-redirects

@choldgraf
Copy link
Member Author

we've also used this in the jupyter book project which has worked well: https://github.com/wpilibsuite/sphinxext-rediraffe

@yuvipanda
Copy link
Contributor

As long as the current URL for nbgitpuller link generator continues to work, I'm happy for this to be wherever :)

@minrk minrk mentioned this issue Apr 4, 2023
6 tasks
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 a pull request may close this issue.

3 participants