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

in the docs, add Binder as an external tool #6807 #9341

Merged
merged 3 commits into from
Jan 31, 2023
Merged

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Jan 27, 2023

What this PR does / why we need it:

Dataverse installations should know that reproducibility is a curl command away! Just enable Binder as an external tool and your users will see a button that will launch a Jupyter notebook or other code (bring your own Dockerfile, if you want!)

Screenshot 2023-01-27 at 12-10-55 Add Binder button for operating on datasets with Jupyter notebooks Python R etc  · Issue #208 · IQSS_dataverse harvard edu

Which issue(s) this PR closes:

Special notes for your reviewer:

For now we're linking to data-exp-lab/girder_ythub#10 until there's a better home.

Note that we're using the redirect service at https://girder.hub.yt/api/v1/ythub/dataverse until external tools can support putting DOIs/PIDs in the URL path.

Suggestions on how to test this:

Build the docs and check if they look ok.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No, this is just a doc change. Here's a preview:

list of external tools

Screen Shot 2023-01-27 at 12 18 59 PM

list of integrations

Screen Shot 2023-01-27 at 12 19 21 PM

Is there a release notes update needed for this change?:

Included.

@@ -0,0 +1 @@
Binder has been added as an external tool. From the dataset page, you can launch Binder, which spins up a computational environment in which you can explore the code and data in the dataset, or write new code, such as a Jupyter notebook.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small tweak - can this say "as an available external tool" or something similar? To make it obvious that it a) has to be configured, b) is optional

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scolapasta ah, good point. Fixed in 4a68a23.

@kcondon kcondon self-assigned this Jan 31, 2023
@pdurbin pdurbin changed the title add Binder as an external tool #6807 in the docs, add Binder as an external tool #6807 Jan 31, 2023
@kcondon kcondon merged commit 170c4b5 into develop Jan 31, 2023
@kcondon kcondon deleted the 6807-binder branch January 31, 2023 19:20
@pdurbin pdurbin added this to the 5.13 milestone Feb 11, 2023
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.

Explore button for Binder
3 participants