jupyterhub / nbgitpuller

Jupyter server extension to sync a git repository one-way to a local path
https://nbgitpuller.readthedocs.io
BSD 3-Clause "New" or "Revised" License
205 stars 84 forks source link

migrate docs to RTD #297

Closed minrk closed 1 year ago

minrk commented 1 year ago

closes #128

I ended up here from:

  1. adding intersphinx link from jupyterhub docs for https://github.com/jupyterhub/jupyterhub/issues/4401
  2. noticed unusual URL and old date
  3. noticed gh-pages builds has apparently never succeeded on main
welcome[bot] commented 1 year ago

Thanks for submitting your first pull request! You are awesome! :hugs:
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! :wave:
Welcome to the Jupyter community! :tada:

yuvipanda commented 1 year ago

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

minrk commented 1 year ago

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 commented 1 year ago

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

yuvipanda commented 1 year ago

@minrk nbgitpuller.link redirect updated!

minrk commented 1 year ago

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

minrk commented 1 year ago

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

minrk commented 1 year ago

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.

frankier commented 1 year ago

For me, the link generator is still not working.

consideRatio commented 1 year ago

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 commented 1 year ago

2023-04-13T13-01-28

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

consideRatio commented 1 year ago

@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 commented 1 year ago

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