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

migrate docs to RTD #297

Merged
merged 4 commits into from
Apr 11, 2023
Merged

migrate docs to RTD #297

merged 4 commits into from
Apr 11, 2023

Conversation

minrk
Copy link
Member

@minrk minrk commented Apr 4, 2023

closes #128

I ended up here from:

  1. adding intersphinx link from jupyterhub docs for FAQ audience confusion jupyterhub#4401
  2. noticed unusual URL and old date
  3. noticed gh-pages builds has apparently never succeeded on main
  • stop building gh-pages, which hasn't been working for a while
  • publish to RTD
  • update links in README
  • update project link
  • add redirects from gh-pages to avoid breaking existing links (redirect gh-pages to readthedocs #298)
  • update nbgitpuller.link to point directly to the new URL (@yuvipanda controls this? I'm not sure how it works)

@welcome
Copy link

welcome bot commented Apr 4, 2023

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly.
welcome
You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

@yuvipanda
Copy link
Contributor

Ya that domain is with me, happy to repoint it. As long as existing links to the generator don't break, all <3

@minrk
Copy link
Member Author

minrk commented Apr 4, 2023

New link is up at https://nbgitpuller.readthedocs.io/en/latest/link.html, if you want to update nbgitpuller.link.

working on setting up redirects, and noticed weird behavior that the current nbgitpuller.link is pointing to https://hub.jupyter.org/nbgitpuller/link which should be 404 (missing .html), but apparently gh-pages automatically adds .html if it's missing? RTD doesn't do that, so a simple rewrite of the URL doesn't quite work. I'm not sure how important it is that all of those redirects work, since no navigation will arrive there, and nbgitpuller.link can be updated itself.

@minrk
Copy link
Member Author

minrk commented Apr 4, 2023

#298 adds all the redirects, including the gh-pages special case

@yuvipanda
Copy link
Contributor

@minrk nbgitpuller.link redirect updated!

@minrk
Copy link
Member Author

minrk commented Apr 4, 2023

link generator on RTD doesn't quite work. I believe due to a theme update, some CSS selector assumptions aren't held.

updates HTML a bit, only loads main on the link page
@minrk
Copy link
Member Author

minrk commented Apr 4, 2023

this now fixes the link generator as well to be compatible with the updated bootstrap in the sphinx theme

rather than using absolute URLs for an internal page
@minrk
Copy link
Member Author

minrk commented Apr 11, 2023

There might be some time pressure to merge this, since now all the links are pointing to the not working link generator page, which is fixed by this PR.

full-width overflows by the width of the sidebar on the opposite side
@consideRatio consideRatio merged commit 728b78b into jupyterhub:main Apr 11, 2023
@frankier
Copy link

For me, the link generator is still not working.

@consideRatio
Copy link
Member

Are you unable to access https://nbgitpuller.readthedocs.io/en/latest/link.html @frankier, or do you mean that the link generator generated links when having third party cookies disabled isn't working against mybinder.org?

@frankier
Copy link

frankier commented Apr 13, 2023

2023-04-13T13-01-28

For me, nothing appears in the "generated binder link appears here" box

@consideRatio
Copy link
Member

consideRatio commented Apr 13, 2023

@frankier when generating a nbgitpuller link for use with mybinder.org that first builds a docker image before it sends a launch request to a jupyterhub, you need to enter two separate URLs.

One for the git repository that is used to build a github image, and one for the content to be pulled with nbgitpuller. Otherwise, a normal mybinder.org link would suffice I think.

There is certainly a UI bug of having a green checkbox on "Git content repository URL" even though its not filled in and is required to be filled in to work.

@frankier
Copy link

Whoops! I was so used to it not working, I suppose I just read that as still broken. Sorry for the noise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use readthedocs?
4 participants