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

Docs Improvement | Setup BinderHub #804

Merged
merged 4 commits into from
Mar 15, 2019
Merged

Docs Improvement | Setup BinderHub #804

merged 4 commits into from
Mar 15, 2019

Conversation

sgibson91
Copy link
Member

This PR proposes some changes to the Set up BinderHub page of the Zero-to-BinderHub documentation and partially addresses issue #803

Changes include:

  • In step 3.4 Install BinderHub:
    • Pass a specific commit hash to the helm install command via --version flag
    • Explain this is a working example and that users should find the commit hash for the most recent version when building their own BinderHub
  • In step 3.5 Connect BinderHub and JupyterHub:
    • For first deployment of a BinderHub, the commit hash parsed to the helm upgrade command via --version flag should match the one used in step 3.4
    • Explain that when updating the BinderHub, the commit hash for a newer chart version can be parsed

* Update --version argument in helm install command to the specific
  0.2.0-3b53fce helm chart
* Explain that the commit hash is all that needs to change to
  install a different helm chart version
Reword step 3.4 Install BinderHub to explain that the commit hash
given is a working example and in practice the user should find
the commit hash for the most recent version.
In Step 3.5, clarify that the commit hash given to the helm upgrade
command should be the same as that given in step 3.4 to the helm
install command on first deployment of a BinderHub. However, it
does not have to be the same if the BinderHub is being updated.
* CircleCI build_docs failure
* Message: Warning, treated as error:
  /home/circleci/project/doc/setup-binderhub.rst:258:Literal block
  ends without a blank line; unexpected unindent.
* Add newline at line 258
@sgibson91
Copy link
Member Author

Can someone advise on the Travis failure please?

@consideRatio
Copy link
Member

This looks good to me ;D I think the travis test failure is just flaking out for some reason unrelated to this PR. I restarted it.

@betatim
Copy link
Member

betatim commented Mar 15, 2019

(restarted travis)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants