Skip to content

Commit

Permalink
Merge pull request jupyterhub#1666 from consideRatio/fix-links
Browse files Browse the repository at this point in the history
docs: fixed links
  • Loading branch information
consideRatio authored May 15, 2020
2 parents 8c2b164 + d13e670 commit 470d85e
Show file tree
Hide file tree
Showing 21 changed files with 69 additions and 56 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ Bumped the underlying JupyterHub to 0.9.5.
### [0.8.0] - [Richie Benaud](https://en.wikipedia.org/wiki/Richie_Benaud) - 2019-01-24
This release contains JupyterHub version 0.9.4. It requires Kubernetes >= 1.11 and Helm >= 2.11.0.
See [the Helm Chart repository](https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release) for
See [the Helm Chart repository](https://github.com/jupyterhub/helm-chart#release-notes) for
a list of relevant dependencies for all Helm Chart versions.
It contains new features, additional configuration options, and bug fixes.
Expand Down
24 changes: 13 additions & 11 deletions doc/source/administrator/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ installations.
## Ingress

If you are using a Kubernetes Cluster that does not provide public IPs for
services directly, you need to use
an [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/)
to get traffic into your JupyterHub. This varies wildly
based on how your cluster was set up, which is why this is in the 'Advanced' section.
services directly, you need to use a [Kubernetes Ingress
resource](https://kubernetes.io/docs/concepts/services-networking/ingress/) to
get traffic into your JupyterHub. This varies wildly based on how your cluster
was set up, which is why this is in the 'Advanced' section.

You can enable the required `ingress` object with the following in your
You can enable the required Ingress resources with the following in your
`config.yaml`

```yaml
Expand All @@ -31,8 +31,8 @@ ingress:
You can specify multiple hosts that should be routed to the hub by listing them
under `ingress.hosts`.

Note that you need to install and configure an
[Ingress Controller](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-controllers)
Note that you need to install and configure an [Ingress
controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/)
for the ingress object to work.

We recommend the community-maintained [nginx-ingress](https://github.com/helm/charts/tree/master/stable/nginx-ingress)
Expand Down Expand Up @@ -199,7 +199,9 @@ The items in this list must be valid kubernetes

### Specifying suitable hub storage

By default, the hub's sqlite-pvc setting will dynamically create a disk to store the sqlite database.
It is possible to [configure other storage classes](https://zero-to-jupyterhub.readthedocs.io/en/latest/reference.html?highlight=pvc#hub-db-type) under hub.db.pvc, but make sure to choose one that
the hub can write quickly and safely to. Slow or higher latency storage classes can cause hub operations to lag which
may ultimately lead to HTTP errors in user environments.
By default, the hub's sqlite-pvc setting will dynamically create a disk to store
the sqlite database. It is possible to [configure other storage
classes](reference/reference.html#hub-db-type) under hub.db.pvc, but make sure
to choose one that the hub can write quickly and safely to. Slow or higher
latency storage classes can cause hub operations to lag which may ultimately
lead to HTTP errors in user environments.
4 changes: 2 additions & 2 deletions doc/source/administrator/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ but we recommend ``read:user`` as this requires no additional configuration by
GitHub organisations and users.
For example, omitting the scope means members of an organisation must `set
their membership to Public
<https://help.github.com/articles/publicizing-or-hiding-organization-membership/>`_
<https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership>`_
to login, whereas setting it to ``read:org`` may require approval of the
application by a GitHub organisation admin.
Please see `this issue
Expand Down Expand Up @@ -142,7 +142,7 @@ CILogon
In order to overcome the `caveats <https://github.com/jupyterhub/oauthenticator/blob/master/oauthenticator/cilogon.py>`_ of implementing CILogon OAuthAuthenticator for JupyterHub,
i.e. default username_claim of ePPN does not work for all providers, e.g. generic OAuth such as Google, Use c.CILogonOAuthenticator.username_claim = 'email' to use email instead of ePPN as the JupyterHub username:

Add to your config.yaml file to `inject extra python based configuration that should be in jupyterhub_config.py <https://zero-to-jupyterhub.readthedocs.io/en/latest/reference.html#hub-extraconfig>`_ as below:
Add to your config.yaml file to `inject extra python based configuration that should be in jupyterhub_config.py </reference/reference.html#hub-extraconfig>`_ as below:

.. code-block:: yaml
Expand Down
2 changes: 1 addition & 1 deletion doc/source/administrator/cost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This requires significantly fewer storage resources, and also results in faster
load times.

For an indicator of how costs scale with computational resources, see the
`Google Cloud pricing page <https://cloud.google.com/compute/pricing>`_.
`Google Cloud pricing page <https://cloud.google.com/compute/all-pricing>`_.

Users
~~~~~
Expand Down
6 changes: 3 additions & 3 deletions doc/source/administrator/optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ situations:
introduced will be pulled to the nodes before the hub pod is updated to
utilize the new image. The name hook-image-puller is a technical name
referring to how a [Helm
hook](https://docs.helm.sh/developing_charts/#hooks) is used to accomplish
hook](https://helm.sh/docs/topics/charts_hooks/) is used to accomplish
this, a more informative name would have been *pre-upgrade-image-puller*.

**NOTE**: With this enabled your `helm upgrade` will take a long time if you
Expand Down Expand Up @@ -215,7 +215,7 @@ where he analyzed its introduction on mybinder.org.
priority depending on how your cluster autoscaler is configured. This is known
to work on GKE, but we don't know how it works on other cloud providers or
kubernetes. See the [configuration
reference](https://zero-to-jupyterhub.readthedocs.io/en/latest/reference.html#scheduling-podpriority) for more details.
reference](/reference/reference.html#scheduling-podpriority) for more details.

### Scaling down efficiently

Expand Down Expand Up @@ -246,7 +246,7 @@ pods.
#### Using a dedicated node pool for users

To set up a dedicated node pool for user pods, we can use [*taints and
tolerations*](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/).
tolerations*](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/).
If we add a taint to all the nodes in the node pool, and a toleration on the
user pods to tolerate being scheduled on a tainted node, we have practically
dedicated the node pool to be used only by user pods.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/administrator/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ popular cloud providers in their
### Confirm that your domain is running HTTPS

There are many ways to confirm that a domain is running trusted HTTPS
certificates. One options is to use the [Qualys SSL Labs](https://ssllabs.com)
certificates. One options is to use the [Qualys SSL Labs](https://www.ssllabs.com/)
security report generator. Use the following URL structure to test your domain:

```
Expand Down
2 changes: 1 addition & 1 deletion doc/source/administrator/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ What version of JupyterHub is installed in the Helm Chart?
----------------------------------------------------------

Each Helm Chart is packaged with a specific version of JupyterHub (and
other software as well). See see the `Helm Chart repository <https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release>`_
other software as well). See see the `Helm Chart repository <https://github.com/jupyterhub/helm-chart#release-notes>`_
for information about the versions of relevant software packages.
4 changes: 2 additions & 2 deletions doc/source/administrator/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ will be performed automatically when you do a `helm upgrade`.
5. Remove the lines added in step 3, and do another [`helm upgrade`](#upgrade-command).


### [Role based access control](https://zero-to-jupyterhub.readthedocs.io/en/latest/security.html#use-role-based-access-control-rbac)
### [Role based access control](/security.html#use-role-based-access-control-rbac)

[RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) is the user security model
in Kubernetes that gives applications only as much access they need to the kubernetes
Expand Down Expand Up @@ -138,7 +138,7 @@ RUN pip install --no-cache-dir jupyterhub==0.8.1
## JupyterHub versions installed in each Helm Chart

Each Helm Chart is packaged with a specific version of JupyterHub (and
other software as well). See the [Helm Chart repository](https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release>) for
other software as well). See the [Helm Chart repository](https://github.com/jupyterhub/helm-chart#release-notes>) for
information about the versions of relevant software packages.

## Troubleshooting
Expand Down
2 changes: 1 addition & 1 deletion doc/source/amazon/step-zero-aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ The Procedure

You should see a list of two nodes, each beginning with ``ip``.

If you want to use kubectl and helm locally (necessary for step #3 in `Setting up Helm <https://z2jh.jupyter.org/en/latest/setup-helm.html#initialization>`_):
If you want to use kubectl and helm locally (necessary for step #3 in `Setting up Helm <setup-helm#initialization>`_):

* run the following on CI host: ``kops export kubecfg``
* copy the contents of ``~/.kube/config`` to the same place on your local system
Expand Down
2 changes: 1 addition & 1 deletion doc/source/community/tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ and references to objects when using ``kubectl``. This lets you
Helm also has an auto-completion script that lets you :kbd:`TAB`-complete
your commands when using Helm.

`Here are the instructions to install helm auto-completion <https://docs.helm.sh/helm/#helm-completion>`_.
`Here are the instructions to install helm auto-completion <https://helm.sh/docs/helm/helm_completion/>`_.


Managing ``kubectl`` contexts
Expand Down
13 changes: 12 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,18 @@ def parse_schema(d, md=[], depth=0, pre=''):

# -- Options for linkcheck builder -------------------------------------------
# ref: http://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
linkcheck_anchors_ignore = ["/#!"]
linkcheck_ignore = [
r'(.*)github\.com(.*)#', # javascript based anchors
r'(.*)/#%21(.*)/(.*)', # /#!forum/jupyter - encoded anchor edge case
"https://your-domain.com", # example
"https://your-domain-name.com", # example
"https://kubernetes.io/docs/tutorials/kubernetes-basics/", # works
"https://cloud.ibm.com/kubernetes/catalog/create", # works
]
linkcheck_anchors_ignore = [
"/#!",
"/#%21",
]


# -- Options for HTML output -------------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions doc/source/ibm/step-zero-ibm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
Kubernetes on IBM Cloud
-----------------------

This guide shows how to deploy JupyterHub on the IBM Cloud using their `Kubernetes service <https://console.bluemix.net/containers-kubernetes/catalog/cluster)>`_.
This guide shows how to deploy JupyterHub on the IBM Cloud using their `Kubernetes service <https://cloud.ibm.com/kubernetes/catalog/create)>`_.
It should provide you with enough knowledge to create a cluster, deploy your application using a Docker image and use a custom domain to use the deployed app.

Before you begin:

* Understand the basics of Kubernetes_.
.. _Kubernetes: https://kubernetes.io/docs/tutorials/kubernetes-basics/)
* Install the IBM Cloud Developer Tools
- Install the `IBM Cloud CLI <https://console.bluemix.net/docs/cli/index.html#overview)>`_.
- Install the `IBM Cloud CLI <https://cloud.ibm.com/docs/cli?topic=cloud-cli-getting-started>`_.
- `curl -sL https://ibm.biz/idt-installer | bash`
- Verify your installation
- `ibmcloud dev help`
Expand All @@ -30,7 +30,7 @@ Procedure:
Kubernetes Service delivers powerful tools by combining Docker and Kubernetes technologies, an intuitive user experience, and built-in security and isolation to automate the deployment, operation, scaling, and monitoring of containerized apps in a cluster of computing hosts.

To set up the Kubernetes cluster:
1. Create a Kubernetes cluster from the `IBM Cloud catalog <https://console.bluemix.net/containers-kubernetes/launch)>`_.
1. Create a Kubernetes cluster from the `IBM Cloud catalog <https://cloud.ibm.com/kubernetes/catalog/create)>`_.
2. When configuring the new cluster, select the **Cluster type** and click **Create Cluster** to provision a Kubernetes cluster.
2.1 In the case of a free cluster you will see something similar to:

Expand All @@ -44,11 +44,11 @@ Procedure:

3. Check the status of your **Cluster** and **Worker Nodes** and wait for them to be **ready**.

Or, if you prefer, create the cluster using the `IBM Cloud CLI tools <https://console.bluemix.net/docs/containers/cs_clusters.html#clusters_cli)>`_
Or, if you prefer, create the cluster using the `IBM Cloud CLI tools <https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install)>`_

2. Configure kubectl

`kubectl <https://kubernetes.io/docs/user-guide/kubectl-overview/)>`_ is a CLI tool to interact with a Kubernetes cluster. In this occasion, you will use it to point forward to the created Kubernetes cluster.
`kubectl <https://kubernetes.io/docs/reference/kubectl/overview/>`_ is a CLI tool to interact with a Kubernetes cluster. In this occasion, you will use it to point forward to the created Kubernetes cluster.

1. Use `ibmcloud login` to log in interactively into the IBM Cloud. Provide the organization (org), location and space under which the cluster is created. You can reconfirm the details by running `ibmcloud target` command.
2. When the cluster is ready, retrieve the cluster configuration by using the cluster's name:
Expand Down Expand Up @@ -79,5 +79,5 @@ Procedure:
Hooray! You have your Kubernetes cluster running; it's time to begin :ref:`creating-your-jupyterhub`.

More info and readings:
- https://console.bluemix.net/docs/tutorials/scalable-webapp-kubernetes.html#deploy-a-scalable-web-application-on-kubernetes
- https://cloud.ibm.com/docs/tutorials?topic=solution-tutorials-scalable-webapp-kubernetes
- https://github.com/IBM-Cloud/get-started-python
2 changes: 1 addition & 1 deletion doc/source/microsoft/step-zero-azure-autoscale.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ If you prefer to use the Azure portal see the `Azure Kubernetes Service quicksta
* ``--location`` specifies the location of the data center you want your resource to be in.
For options, see the
`Azure list of locations that support AKS
<https://docs.microsoft.com/en-us/azure/aks/container-service-quotas#region-availability>`_.
<https://docs.microsoft.com/en-us/azure/aks/quotas-skus-regions#region-availability>`_.
* ``--output table`` specifies that the output should be in human readable
format, rather than the default JSON output. We shall use this with most
commands when executing them by hand.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/microsoft/step-zero-azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ If you prefer to use the Azure portal see the `Azure Kubernetes Service quicksta
* ``--location`` specifies the location of the data center you want your resource to be in.
In this case, we used the ``centralus`` location. For other options, see the
`Azure list of locations that support AKS
<https://docs.microsoft.com/en-us/azure/aks/container-service-quotas#region-availability>`_.
<https://docs.microsoft.com/en-us/azure/aks/quotas-skus-regions#region-availability>`_.
* ``--output table`` specifies that the output should be in human readable
format, rather than the default JSON output. We shall use this with most
commands when executing them by hand.
Expand Down
4 changes: 2 additions & 2 deletions doc/source/redhat/step-zero-openshift.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Kubernetes on Red Hat OpenShift
For setting up JupyterHub on OpenShift, check out the `JupyterHub on OpenShift <https://github.com/jupyter-on-openshift/jupyterhub-quickstart>`_
project. It provides an OpenShift template based JupyterHub deployment. Zero to JupyterHub uses
`helm <https://helm.sh>`_ which is currently usable with OpenShift; yet deploying helm on OpenShift
is somewhat complicated (see RedHat's blog post on `Getting Started with Helm on OpenShift <https://blog.openshift.com/getting-started-helm-openshift/>`_).
is somewhat complicated (see RedHat's blog post on `Getting Started with Helm on OpenShift <https://www.openshift.com/blog/getting-started-helm-openshift>`_).

Additional resources about Jupyter on OpenShift
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- An excellent series of OpenShift blog posts on Jupyter and OpenShift
authored by Red Hat developer, Graham Dumpleton, are
available on the `OpenShift blog <https://blog.openshift.com/tag/jupyter/>`_.
available on the `OpenShift blog <https://www.openshift.com/blog/jupyter-openshift-using-openshift-data-analytics>`_.
6 changes: 3 additions & 3 deletions doc/source/reference/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,19 @@ details.
behave on a computer. Some common examples are ``PATH``, ``HOME``, and
``EDITOR``.

`Helm chart <https://docs.helm.sh/developing_charts/#charts>`_
`Helm chart <https://helm.sh/docs/topics/charts/>`_
A Helm chart is a group of :term:`Helm templates <Helm template>` that
can, given its default values and overrides in provided ``yaml`` files,
render to a set of :term:`Kubernetes resources <Kubernetes resource>` that
can be easily installed to your Kubernetes cluster. In other words a Helm
chart is like a configurable installation of software and infrastructure
to exist on a cloud.

`Helm template <https://docs.helm.sh/chart_template_guide/#the-chart-template-developer-s-guide>`_
`Helm template <https://helm.sh/docs/chart_template_guide/>`_
A Helm template (``.yaml`` files), can given values, render to a
:term:`Kubernetes resource`.

`Helm values <https://docs.helm.sh/chart_template_guide/#values-files>`_
`Helm values <https://helm.sh/docs/chart_template_guide/values_files/>`_
:term:`Helm charts <Helm chart>` has a set of predefined values
(`values.yaml`) typically overridden by other values in `config.yaml`. The
final values are used to generate :term:`Kubernetes resources <Kubernetes
Expand Down
4 changes: 2 additions & 2 deletions doc/source/repo2docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,5 +159,5 @@ to configure JupyterHub to build off of this image:
.. REFERENCES USED:
.. _repo2docker: https://github.com/jupyter/repo2docker
.. _downloading and installing Docker: https://www.docker.com/community-edition
.. _pip: https://pip.readthedocs.io/en/latest/user_guide/#requirements-files
.. _downloading and installing Docker: https://docs.docker.com/get-docker/
.. _pip: https://pip.pypa.io/en/latest/user_guide/#requirements-files
2 changes: 1 addition & 1 deletion doc/source/setup-jupyterhub/setup-helm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Installation
------------

While several `methods to install Helm
<https://github.com/helm/helm/blob/master/docs/install.md>`_ exists, the
<https://v2.helm.sh/docs/using_helm/#installing-helm>`_ exists, the
simplest way to install Helm is to run Helm's installer script in a terminal:

.. code:: bash
Expand Down
2 changes: 1 addition & 1 deletion doc/source/setup-jupyterhub/setup-helm3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Installation
------------

While several `methods to install Helm
<https://github.com/helm/helm/blob/master/docs/install.md>`_ exist, the
<https://helm.sh/docs/intro/install/>`_ exist, the
simplest way to install Helm is to run Helm's installer script in a terminal:

.. code:: bash
Expand Down
4 changes: 2 additions & 2 deletions doc/source/setup-jupyterhub/setup-jupyterhub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Install JupyterHub
where:

- ``RELEASE`` refers to a `Helm release name
<https://docs.helm.sh/glossary/#release>`_, an identifier used to
<https://helm.sh/docs/glossary/#release>`_, an identifier used to
differentiate chart installations. You need it when you are changing or
deleting the configuration of this chart installation. If your Kubernetes
cluster will contain multiple JupyterHubs make sure to differentiate them.
Expand Down Expand Up @@ -131,7 +131,7 @@ Install JupyterHub
Helm chart is paired with a specific version of JupyterHub. E.g.,
``0.7.0`` of the Helm chart runs JupyterHub ``0.9.2``.
For a list of which JupyterHub version is installed in each version
of the Z2JH Helm Chart, see the `Helm Chart repository <https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release>`_.
of the Z2JH Helm Chart, see the `Helm Chart repository <https://github.com/jupyterhub/helm-chart#release-notes>`_.

3. While Step 2 is running, you can see the pods being created by entering in
a different terminal:
Expand Down
Loading

0 comments on commit 470d85e

Please sign in to comment.