From 9689badf3ed4318dfaa002625a5f51013911821e Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Wed, 26 Oct 2022 13:50:29 -0400 Subject: [PATCH 1/2] add ReviewNB instructions to readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index d00dd51b..7d838564 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,21 @@ You can use this template for your own event! We've designed this template so that you should only have to edit a few files with intuitive syntax. When changes are pushed to GitHub, [continuous integration](./.github/README.md) takes care of converting these files into HTML and publishing the website. +### Additional options to consider +[ReviewNB](https://www.reviewnb.com/) is a great tool for viewing changes in Jupyter Notebooks. +Someone with admin privelages must activate it for each repository you create from this template. +To activate: + +1. Go to [reviewnb.com](https://www.reviewnb.com/). +1. Select the "Connect to GitHub" button. +1. Select "+/- REPOSITORIES" from the menu or bottom of the page. +1. Choose the organization where your repo lives. +1. Toggle the "Only select repositories" button and choose your repo from the dropdown. +1. Select "Install". + +Great! Now ReviewNB will post a rich-diff of your notebooks each time a PR is opened. + + ## How to contribute We are always trying to improve upon this template for future events and welcome contributions. Have a look at our [code of conduct](./CODE_OF_CONDUCT.md) and [contributing guide](./CONTRIBUTING.md). From 68cbfedd19f0ca0e904a574569d40e6b03f030eb Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 23 Feb 2024 15:22:13 -0500 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d838564..27e807cb 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ We've designed this template so that you should only have to edit a few files wi ### Additional options to consider [ReviewNB](https://www.reviewnb.com/) is a great tool for viewing changes in Jupyter Notebooks. -Someone with admin privelages must activate it for each repository you create from this template. +Someone with admin privileges must activate it for each repository you create from this template. To activate: 1. Go to [reviewnb.com](https://www.reviewnb.com/).