Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-Authored-By: Carol Willing <[email protected]>
  • Loading branch information
consideRatio and willingc committed Oct 13, 2019
1 parent 162632a commit c89542a
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .binder/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# What is this folder about?

It's contains the dependency information required by [a notebook](doc/ntbk/draw_function.ipynb) that [we reference](doc/source/cost.rst) in our documentation to run on mybinder.org. All it takes is the click of [a link](http://mybinder.org/v2/gh/jupyterhub/zero-to-jupyterhub-k8s/master?filepath=doc/ntbk/draw_function.ipynb) thanks to this.
This folder contains the dependency information required by [a notebook](doc/ntbk/draw_function.ipynb) [referenced](doc/source/cost.rst) in our documentation to run on mybinder.org. This dependency information allows a click of [a link](http://mybinder.org/v2/gh/jupyterhub/zero-to-jupyterhub-k8s/master?filepath=doc/ntbk/draw_function.ipynb) to create the rendered notebook.
4 changes: 2 additions & 2 deletions .circleci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ We use CircleCI to build documentation previews for PRs, as configured through
[.circleci/config.yml], this allows us to easily preview documentation changes
in a PR in its final form before the PR is merged.

When a PR is merged [readthedocs.yml](readthedocs.yml) will help ReadTheDocs
build and publish it on https://z2jh.jupyter.org.
When a PR is merged, the configuration in [readthedocs.yml](readthedocs.yml) will help ReadTheDocs
build the docs and publish to https://z2jh.jupyter.org.
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release process

Start by making a release issue using the template below, it can be followed to
Start by making a release issue using the template below. The issue checklist can be followed to
release a new version of the Helm chart and help everybody coordinate. Do some
copy pasting!

Expand Down
2 changes: 2 additions & 0 deletions ci/kind-load-docker-images.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#!/usr/bin/env python3
"""
Functions using kind to load docker images.
Run `kind load docker-image <image:tag>` on all the docker images within
values.yaml that is available locally on the host as first verified with `docker
images --quiet <image:tag>`. If we could capture this directly from chartpress
Expand Down
2 changes: 1 addition & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# What is this folder about?

We have setup tests for [pytest](https://docs.pytest.org/en/latest/) that will run in our CI/CD pipeline on Travis. These test assumes it is able to speak directly to a running hub within a Kubernetes cluster etc. In practice, they assume you have been using `dev` script to set it all up.
This folder contains tests that [pytest](https://docs.pytest.org/en/latest/) will run in our CI/CD pipeline on Travis. These tests must be able to speak directly to a running hub within a Kubernetes cluster etc. In practice, the tests will be set up using a `dev` script.

0 comments on commit c89542a

Please sign in to comment.