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

[DOC] Satisfy linkcheck #2080

Merged
merged 2 commits into from Mar 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test-docs.yaml
Expand Up @@ -26,7 +26,7 @@ jobs:
steps:
- uses: actions/checkout@v2
with:
# chartpress is used by doc/conf.py, part of doc/doc-requirements.txt,
# chartpress is used by doc/conf.py,
# and requires information about the latest tagged commit, which
# requires the git history.
fetch-depth: 0
Expand All @@ -35,7 +35,7 @@ jobs:
python-version: "3.8"

- name: Install deps
run: pip install --no-cache-dir -r doc/doc-requirements.txt
run: pip install -r doc/requirements.txt

- name: make linkcheck
run: |
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Expand Up @@ -22,4 +22,4 @@ python:
# accepting the existing version.
#
# ref: https://github.com/readthedocs/readthedocs.org/blob/0e3df509e7810e46603be47d268273c596e68455/readthedocs/doc_builder/python_environments.py#L335-L344
- requirements: doc/doc-requirements.txt
- requirements: doc/requirements.txt
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -30,7 +30,7 @@ This needs to be installed:
- Python 3.6+ (install at [Anaconda.com](https://www.anaconda.com/distribution/) or [Python.org](https://www.python.org/downloads/)) and dependencies:
```shell
pip install -r dev-requirements.txt
pip install -r doc/doc-requirements.txt
pip install -r doc/requirements.txt
```

You can check if you have it all like this:
Expand Down
2 changes: 1 addition & 1 deletion doc/README.md
Expand Up @@ -9,7 +9,7 @@ in the `readthedocs.yml` file, and made available on

```shell
cd doc
pip install -r doc-requirements.txt
pip install -r requirements.txt
```

```
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions doc/source/administrator/authentication.md
Expand Up @@ -166,7 +166,7 @@ hub:
```

```{admonition} Alternative scopes
While you can set other scopes than `read:user` as described in [GitHub OAuth scopes documentation](https://docs.github.com/en/free-pro-team@latest/developers/apps/scopes-for-oauth-apps), we recommend `read:user`.
While you can set other scopes than `read:user` as described in [GitHub OAuth scopes documentation](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps), we recommend `read:user`.

With `read:user`, the user will be requested to permit JupyterHub to read their profile data. The benefit of this choice is that it won't require configuration by the GitHub organizations' admins by by its members.
```
Expand All @@ -175,7 +175,7 @@ With `read:user`, the user will be requested to permit JupyterHub to read their

Google authentication is used by many universities (it is part of "G Suite").

If your institution is a [G Suite customer](https://gsuite.google.com) that
If your institution is a [G Suite customer](https://workspace.google.com) that
integrates with Google services such as Gmail, Calendar, and Drive, you can
authenticate users to your JupyterHub using Google for authentication.

Expand Down
5 changes: 4 additions & 1 deletion doc/source/jupyterhub/installation.md
Expand Up @@ -110,7 +110,10 @@ can try with `nano config.yaml`.
kubectl get pod --namespace jhub
```

To remain sane we recommend that you [enable autocompletion for kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion)
To remain sane we recommend that you enable autocompletion for kubectl
(follow [the kubectl installation instructions for your platform](https://kubernetes.io/docs/tasks/tools/#kubectl)
to find the shell autocompletion instructions)

and set a default value for the `--namespace` flag:

```
Expand Down
Expand Up @@ -11,7 +11,7 @@ If you prefer to use the Digital Ocean portal see the [Digital Ocean Get Started

1. **Install command-line tools locally**. You'll need at least v1.13.0.

You can either follow the [installation instructions](https://github.com/digitalocean/doctl/blob/master/README.md) or use the commands below:
You can either follow the [installation instructions](https://github.com/digitalocean/doctl/blob/main/README.md) or use the commands below:

```
wget https://github.com/digitalocean/doctl/releases/download/v1.13.0/doctl-1.13.0-linux-amd64.tar.gz
Expand Down
3 changes: 2 additions & 1 deletion doc/source/resources/community.md
Expand Up @@ -37,7 +37,8 @@ Kubernetes has a helper script that allows you to auto-complete commands
and references to objects when using `kubectl`. This lets you
{kbd}`TAB`-complete and saves a lot of time.

[Here are the instructions to install kubectl auto-completion](https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion).
Follow [the kubectl installation instructions for your platform](https://kubernetes.io/docs/tasks/tools/#kubectl)
to find the shell autocompletion instructions.

## `helm` autocompletion

Expand Down