Skip to content

Commit 50cb222

Browse files
committed
Improve text in documentation
based on review. Thanks to @manics.
1 parent 2a98741 commit 50cb222

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/source/zero-to-binderhub/setup-binderhub.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ Create a file called ``config.yaml``.
115115
Exposing JupyterHub
116116
~~~~~~~~~~~~~~~~~~~
117117

118-
By default, JupyterHub is exposed as ``LoadBalancer``.
119-
If you want to expose JupyterHub using a ingress controller,
118+
By default, JupyterHub is exposed as a ``LoadBalancer``.
119+
If you want to expose JupyterHub using an ingress controller,
120120
you need to add::
121121

122122
jupyterhub:
@@ -126,14 +126,14 @@ you need to add::
126126
ingress:
127127
enabled: true
128128
annotations:
129-
# use the shared ingress-nginx
129+
# replace with your ingress class
130130
kubernetes.io/ingress.class: "nginx"
131131
hosts:
132132
- jupyterhub.XXX.XXX.XXX.XXX.nip.io
133133

134134
The above snippet assumes that you are using `Ingress NGINX Controller <https://kubernetes.github.io/ingress-nginx/>`_
135135
and uses `nip.io <https://nip.io/>`_ to provide you with a temporary domain
136-
to the IPv6 ``XXX.XXX.XXX.XXX``.
136+
to the IP ``XXX.XXX.XXX.XXX``.
137137

138138
Exposing BinderHub
139139
~~~~~~~~~~~~~~~~~~
@@ -391,16 +391,18 @@ JupyterHub. Now, add the following lines to ``config.yaml`` file::
391391
When using ``Ingress``
392392
~~~~~~~~~~~~~~~~~~~~~~
393393

394-
If JupyterHub is exposed using ``Ingress``,
395-
you can use any of the domains that JupyterHub is answering.
396-
For example, ::
394+
If JupyterHub is exposed using an ``Ingress``,
395+
copy the domains that JupyterHub is answering
396+
(for example, ``http://jupyterhub.XXX.XXX.XXX.XXX.nip.io``)
397+
and add to ``config.yaml``::
397398

398399
config:
399400
BinderHub:
400401
hub_url: http://jupyterhub.XXX.XXX.XXX.XXX.nip.io
401402

402-
The above snippet `nip.io <https://nip.io/>`_
403-
to provide you with a temporary domain to the IPv6 ``XXX.XXX.XXX.XXX``.
403+
In the above snippet,
404+
`nip.io <https://nip.io/>`_ provides you
405+
with a temporary domain to the IP ``XXX.XXX.XXX.XXX``.
404406

405407
Updating the deployment
406408
~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)