update Jupyter Readme for notebook sharing #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
tlvu
added a commit
to bird-house/birdhouse-deploy-ouranos
that referenced
this pull request
Sep 14, 2021
Match PR Ouranosinc/PAVICS-landing#31 that moved the README.ipynb file outside of birdhouse-deploy repo.
huard
reviewed
Sep 14, 2021
huard
approved these changes
Sep 14, 2021
Co-authored-by: David Huard <huard.david@ouranos.ca>
tlvu
added a commit
to bird-house/birdhouse-deploy
that referenced
this pull request
Sep 15, 2021
This repo is intended to be generic. That README.ipynb is moved to PR Ouranosinc/PAVICS-landing#31.
tlvu
added a commit
to bird-house/birdhouse-deploy
that referenced
this pull request
Sep 15, 2021
This repo is intended to be generic. That README.ipynb file is moved to PR Ouranosinc/PAVICS-landing#31. The deployment part is moved to PR bird-house/birdhouse-deploy-ouranos#15.
tlogan2000
approved these changes
Sep 15, 2021
tlvu
merged commit 92170d8
into
migrate-pavics-jupyter-readme-from-birdhouse-deploy-repo
tlvu
added a commit
that referenced
this pull request
Sep 15, 2021
…from-birdhouse-deploy-repo Migrate pavics jupyter readme from birdhouse deploy repo See PR #31.
tlvu
added a commit
to bird-house/birdhouse-deploy-ouranos
that referenced
this pull request
Sep 15, 2021
deploy pavics-landing: add Jupyter env Readme deployment Match PR Ouranosinc/PAVICS-landing#31 that moved the `README.ipynb` file outside of birdhouse-deploy repo. Match PR bird-house/birdhouse-deploy#190 that deleted the deployment of `README.ipynb` at the old location.
tlvu
added a commit
to bird-house/birdhouse-deploy
that referenced
this pull request
Sep 20, 2021
…yter jupyter: sample code for simple and naive notebook sharing between users and README file relocation and deployment change ## Overview * **Backward-incompatible change**: do not, by default, volume-mount the Jupyter env README file since that file has been deleted in this repo. That file is fairly specific to Ouranos while we want this repo to be generic. PR Ouranosinc/PAVICS-landing#31 restored that file in PAVICS-landing repo that is Ouranos specific. * Previous default added as a comment in `env.local` for existing deployment to restore the previous behavior. Although the README file has been deleted in this PR, it has already been previously deployed so existing system can restore the previous behavior of having the existing README file. This file will simply be not updated anymore. * Delete the deployment of that README file as well since that README file is deleted. PR bird-house/birdhouse-deploy-ouranos#15 restore the deployment for Ouranos. * Each Org will be responsible for the deployment of their own README file. PR bird-house/birdhouse-deploy-ouranos#15 can be used as a working example from Ouranos. * Add sample code for simple and naive notebook sharing between Jupyter users. ## Notebook sharing details Shared notebooks will be visible to all users logged in, even the public demo user so do not share any notebooks containing sensitive private info. Can not share to a specific user. Anyone will see the login id of everyone else so if the login id needs to be kept private, change this sample code. Inside Jupyter, user will have the following additional folders: ``` . ├── mypublic/ # writable by current user │ ├── current-user-public-share-file.ipynb │ ├── (...) ├── public/ # read-only for everyone │ ├── loginid-1-public/ │ │ └── loginid-1-shared-file.ipynb │ │ └── (...) │ ├── loginid-2-public/ │ │ └── loginid-2-shared-file.ipynb │ │ └── (...) │ ├── (...)-public/ │ │ └── (...) ``` User can drop their files to be shared under folder `mypublic` and see other users share under `public/{other-loginid}-public`. Matching PR Ouranosinc/PAVICS-landing#31 updating README inside the Jupyter env to explain this new sharing mechanism. Deployed to https://medus.ouranos.ca/jupyter/ for acceptance testing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explain the new
mypublicandpublicfolder (PR bird-house/birdhouse-deploy#190).Show
/notebook_dir/is the notebook root (issue Ouranosinc/pavics-sdi#227).What is not shown but will be effective is I've moved this file that is originally at https://github.com/bird-house/birdhouse-deploy/blob/537f997a1a9a57901b5072cc6c6f950f92f37e9a/docs/source/notebooks/README.ipynb to this repo since this file is fairly Ouranos specific and has some overlapping info with the landing homepage (PR #32).
I am setting up so we can harmonize this
README.ipynbbetter with the landing homepage in the future.Deployment of this README file is handled by PR bird-house/birdhouse-deploy-ouranos#15.