From dd5b011dfe189d90cae97fdb875673cd76101e5d Mon Sep 17 00:00:00 2001 From: Ayaz Salikhov Date: Mon, 7 Feb 2022 01:43:29 +0300 Subject: [PATCH] Add a tool to check broken URLs easily --- CONTRIBUTING.md | 2 +- Makefile | 3 +++ README.md | 12 ++++++------ docs/contributing/stacks.md | 2 +- docs/maintaining/tasks.md | 2 +- docs/using/recipes.md | 2 +- docs/using/running.md | 2 +- 7 files changed, 14 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5770172..41f55540 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ Thanks for contributing! Please see the -**Contributor Guide** section in [the documentation](https://jupyter-docker-stacks.readthedocs.io) for +**Contributor Guide** section in [the documentation](https://jupyter-docker-stacks.readthedocs.io/en/latest/) for information about how to contribute [package updates](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/packages.html), [recipes](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/recipes.html), diff --git a/Makefile b/Makefile index c192ceae..29309326 100644 --- a/Makefile +++ b/Makefile @@ -140,6 +140,9 @@ install-dev-env: ## install libraries required to build images and run tests docs: ## build HTML documentation sphinx-build -W docs/ docs/_build/ +linkcheck-docs: ## check broken links + sphinx-build -b linkcheck docs/ docs/_build/ + install-docs-env: ## install libraries required to build docs @pip install -r requirements-docs.txt diff --git a/README.md b/README.md index 966c35c3..ddcce871 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![Github actions badge](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml/badge.svg)](https://github.com/jupyter/docker-stacks/actions/workflows/docker.yml "Docker images build status") [![Read the Docs badge](https://img.shields.io/readthedocs/jupyter-docker-stacks.svg)](https://jupyter-docker-stacks.readthedocs.io/en/latest/ "Documentation build status") [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jupyter/docker-stacks/master.svg)](https://results.pre-commit.ci/latest/github/jupyter/docker-stacks/master "pre-commit.ci build status") -[![Discourse badge](https://img.shields.io/discourse/https/discourse.jupyter.org/users.svg?color=%23f37626)](https://discourse.jupyter.org/ "Jupyter Discourse Forum") -[![Binder badge](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb "Launch a jupyter/base-notebook container on mybinder.org") +[![Discourse badge](https://img.shields.io/discourse/users.svg?color=%23f37626&server=https%3A%2F%2Fdiscourse.jupyter.org)](https://discourse.jupyter.org/ "Jupyter Discourse Forum") +[![Binder badge](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb "Launch a jupyter/base-notebook container on mybinder.org") Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter) containing Jupyter applications and interactive computing tools. You can use a stack image to do any of the following (and more): @@ -22,7 +22,7 @@ Otherwise, the examples below may help you get started if you [have Docker insta know [which Docker image](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html) you want to use and want to launch a single Jupyter Server in a container. -The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) describes additional uses and features in detail. +The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/en/latest/) describes additional uses and features in detail. **Example 1:** @@ -63,7 +63,7 @@ system when the container exits, but any changes made to the `~/work` directory ## Contributing -Please see the [Contributor Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) for +Please see the [Contributor Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/en/latest/) for information about how to contribute package updates, recipes, features, tests, and community maintained stacks. @@ -98,7 +98,7 @@ This change is tracked in the issue [#1217](https://github.com/jupyter/docker-st ## Alternatives -- [jupyter/repo2docker](https://github.com/jupyter/repo2docker) - Turn git repositories into +- [jupyter/repo2docker](https://github.com/jupyterhub/repo2docker) - Turn git repositories into Jupyter-enabled Docker Images - [openshift/source-to-image](https://github.com/openshift/source-to-image) - A tool for building/building artifacts from source and injecting into docker images @@ -107,7 +107,7 @@ This change is tracked in the issue [#1217](https://github.com/jupyter/docker-st ## Resources -- [Documentation on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) +- [Documentation on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/en/latest/) - [Issue Tracker on GitHub](https://github.com/jupyter/docker-stacks) - [Jupyter Discourse Forum](https://discourse.jupyter.org/) - [Jupyter Website](https://jupyter.org) diff --git a/docs/contributing/stacks.md b/docs/contributing/stacks.md index e31eda79..dcd267e4 100644 --- a/docs/contributing/stacks.md +++ b/docs/contributing/stacks.md @@ -86,7 +86,7 @@ The cookiecutter template comes with a `.github/workflows/docker.yml` file, whic ``` This will trigger the CI pipeline whenever you push to your `main` or `master` branch and when any Pull Requests are made to your repository. - For more details on this configuration, visit the [GitHub actions documentation on triggers](https://docs.github.com/en/actions/reference/events-that-trigger-workflows). + For more details on this configuration, visit the [GitHub actions documentation on triggers](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows). 2. Commit your changes and push to GitHub. 3. Head back to your repository and click on the **Actions** tab. diff --git a/docs/maintaining/tasks.md b/docs/maintaining/tasks.md index eb569b4c..db6a0915 100644 --- a/docs/maintaining/tasks.md +++ b/docs/maintaining/tasks.md @@ -33,7 +33,7 @@ When there's a new stack definition, do the following before merging the PR with [in the documentation](https://github.com/jupyter/docker-stacks/blob/master/docs/using/selecting.md#image-relationships). The image links to the [blockdiag source](http://interactive.blockdiag.com/) used to create it. 2. Ensure the PR updates the [Makefile](https://github.com/jupyter/docker-stacks/blob/master/Makefile) which is used to build the stacks in order on GitHub Actions. -3. Ensure necessary tags / manifests are added for the new image in the [tagging](https://github.com/jupyter/docker-stacks/blob/master/tagging) folder. +3. Ensure necessary tags / manifests are added for the new image in the [tagging](https://github.com/jupyter/docker-stacks/tree/master/tagging) folder. 4. Create a new repository in the `jupyter` org on Docker Hub named after the stack folder in the git repo. 5. Grant the `stacks` team permission to write to the repo. diff --git a/docs/using/recipes.md b/docs/using/recipes.md index 16ebd18c..75fc20fb 100644 --- a/docs/using/recipes.md +++ b/docs/using/recipes.md @@ -69,7 +69,7 @@ RUN mamba install --yes --file /tmp/requirements.txt && \ fix-permissions "/home/${NB_USER}" ``` -Ref: [docker-stacks/commit/79169618d571506304934a7b29039085e77db78c](https://github.com/jupyter/docker-stacks/commit/79169618d571506304934a7b29039085e77db78c#commitcomment-15960081) +Ref: [docker-stacks/commit/79169618d571506304934a7b29039085e77db78c](https://github.com/jupyter/docker-stacks/commit/79169618d571506304934a7b29039085e77db78c#r15960081) ## Add a Python 2.x environment diff --git a/docs/using/running.md b/docs/using/running.md index 38bae038..b8a8963c 100644 --- a/docs/using/running.md +++ b/docs/using/running.md @@ -103,7 +103,7 @@ docker rm notebook [Binder](https://mybinder.org/) is a service that allows you to create and share custom computing environments for projects in version control. You can use any of the Jupyter Docker Stacks images as a basis for a Binder-compatible Dockerfile. See the -[docker-stacks example](https://mybinder.readthedocs.io/en/latest/sample_repos.html#using-a-docker-image-from-the-jupyter-docker-stacks-repository) and +[docker-stacks example](https://mybinder.readthedocs.io/en/latest/examples/sample_repos.html#using-a-docker-image-from-the-jupyter-docker-stacks-repository) and [Using a Dockerfile](https://mybinder.readthedocs.io/en/latest/tutorials/dockerfile.html) sections in the [Binder documentation](https://mybinder.readthedocs.io/en/latest/index.html) for instructions.