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

Add mybinder badge #19

Merged
merged 6 commits into from
Nov 15, 2017
Merged

Conversation

ian-r-rose
Copy link
Member

Adds mybinder and GitHub buttons to the toolbar. The mybinder button is only active if the user is currently viewing a repository that contains one of the special files listed in repo2docker.

Still not working: specifying other branches than master, launching binder with more a more specific subdirectory.
cc. @choldgraf @yuvipanda.

@yuvipanda
Copy link

/cc @willingc @Carreau @minrk @betatim too! this is awesome!

@ian-r-rose
Copy link
Member Author

Screengrab:
image

@willingc
Copy link
Collaborator

@ian-r-rose Lovely 👍 Any chance that you can make the icons look more clickable (perhaps that was what the latest style tweak did)? Great job.

@ian-r-rose
Copy link
Member Author

The icons gain a border upon mouse hover (in the same way that buttons in the filebrowser do).

@ian-r-rose ian-r-rose merged commit 9a353ff into jupyterlab:master Nov 15, 2017
@choldgraf
Copy link
Collaborator

this is super cool! thanks @ian-r-rose ! A couple quick thoughts:

  1. We should (in a diff issue) have a conversation about what kind of "official" binder buttons we should put out there. E.g., I like @ian-r-rose using the binder logo here...
  2. One trick here is that the binder build files are quite common outside of a binder context (e.g. requirements.txt). I'm a little concerned that the plugin will catch these cases where the repo still isn't binderable... what do you all think?

@ian-r-rose
Copy link
Member Author

  1. Agreed. For prior work on this, see the Jupyter branding guidelines here. In general, we have said it is fine to use the logo if advertising integration with the project, but not to use it for other purposes. Modifying it is also against the guidelines. (As I have done slightly by removing the binder text!).

  2. Yes, that is tricky, and would require much more introspection into the repository. Here, I am only checking if files with those names exist, and it will definitely catch cases where binder will not work. You probably have a better idea of how to improve the screening than I.

@willingc
Copy link
Collaborator

  1. @ian-r-rose, if I understand correctly the jupyterlab user could choose whether or not to install/disable this feature. If so, then the user can opt out if desired. Perhaps adding to a message on hover that it builds based on current repo contents and YMMV (i.e. user would need to make sure the contents are binderable).

@choldgraf
Copy link
Collaborator

That's a good point about people being able to opt out @willingc ... I like the idea of it being enabled by default though, it'll hopefully let some people know about the binder world!

@ian-r-rose
Copy link
Member Author

  1. @willingc, it is currently enabled in this plugin. I have been thinking through how to make it more configurable though, including
  • whether to make it disabled
  • the ability to set a different deployment of binderhub

@ian-r-rose
Copy link
Member Author

(Since this is an extension to JupyterLab, none of it is installed by default in a basic pip install jupyterlab)

@willingc
Copy link
Collaborator

Thanks @ian-r-rose. For now, I wouldn't be too concerned about 2 until we can spec out what would specifically be needed.

zhiyuli pushed a commit to cybergis/jupyterlab-github that referenced this pull request Jun 6, 2021
generalized request method--related handler
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 this pull request may close these issues.

4 participants