Skip to content

Make releasable version of notebooks#10

Merged
JeanBilheux merged 33 commits into
neutronimaging:make_releasable_version_of_notebooksfrom
KedoKudo:make_releasable_version_of_notebooks
Oct 1, 2020
Merged

Make releasable version of notebooks#10
JeanBilheux merged 33 commits into
neutronimaging:make_releasable_version_of_notebooksfrom
KedoKudo:make_releasable_version_of_notebooks

Conversation

@KedoKudo
Copy link
Copy Markdown
Contributor

Main changes in this PR

  • Simply the top-level folder structure
    • Reduce the number of file visible at the root level
    • Change the name of the installation script to reflect its functionality
    • Remove outdated files
  • Add support for Docker
    • Image is built and published on Dockerhub
  • Update instructions in Readme.md

KedoKudo and others added 30 commits September 25, 2020 19:22
…ebooks' into make_releasable_version_of_notebooks
…ebooks' into make_releasable_version_of_notebooks
…ebooks' into make_releasable_version_of_notebooks
…ebooks' into make_releasable_version_of_notebooks
Made space for instructions on how to bring the repository to the user computer
jupyter notebooks firing up
@KedoKudo
Copy link
Copy Markdown
Contributor Author

@JeanBilheux
Additional instructions on how to use the docker env are added as discussed. Please let me know if there is anything else need to be updated.

@JeanBilheux
Copy link
Copy Markdown
Member

I think we should remove the instructions regarding docker in the README to avoid the confusion with the users as this is not working right now.
Instead of git clone ..., can we clone a specific tag instead, stable release version?

@KedoKudo
Copy link
Copy Markdown
Contributor Author

KedoKudo commented Oct 1, 2020

I think we should remove the instructions regarding docker in the README to avoid the confusion with the users as this is not working right now.

Okay, I will remove the docker related instructions.

Instead of git clone ..., can we clone a specific tag instead, stable release version?

git clone will set the origin, and the user can select which branch locally with git checkout -b.
My original understanding is that this make_releasable_version_of_notebook will eventually becomes the main branch, which means there is no need for user to specify branch name as the default branch is the one they will use.
But it sounds like this is not going to be the case, so I will add more specific instructions in Readme.md

remove docker related info here
remove residual mentioning of docker
@JeanBilheux
Copy link
Copy Markdown
Member

Thanks @KedoKudo. I'm trying to minimize the number of commands the user will have to type and things they will need to adapt as some of our users are really allergic to any command line input 👍

remove mentioning of how to checkout specific branch, only provide a single command for users to check the branch `make_releasable_version_of_notebook` directly.
@KedoKudo
Copy link
Copy Markdown
Contributor Author

KedoKudo commented Oct 1, 2020

@JeanBilheux Could you take another look at the updated version of instructions, in case there is anything I missed?

@JeanBilheux
Copy link
Copy Markdown
Member

I like it. We may need to point to a branch/tag that has a better name than the one I picked "make_releasable...etc" but that will be easy to change.

@JeanBilheux JeanBilheux merged commit 7367cf5 into neutronimaging:make_releasable_version_of_notebooks Oct 1, 2020
@KedoKudo KedoKudo deleted the make_releasable_version_of_notebooks branch October 1, 2020 13:53
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.

2 participants