hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-14 21:42:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a tool to check broken URLs easily

Browse Source
This commit is contained in:
Ayaz Salikhov
2022-02-07 01:43:29 +03:00
parent 44b775513b
commit dd5b011dfe
7 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -1,7 +1,7 @@
<!-- markdownlint-disable MD041 --> <!-- markdownlint-disable MD041 -->
Thanks for contributing! Please see the 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 information about how to contribute
[package updates](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/packages.html), [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), [recipes](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/recipes.html),

3
Makefile
View File

@@ -140,6 +140,9 @@ install-dev-env: ## install libraries required to build images and run tests
docs: ## build HTML documentation docs: ## build HTML documentation
sphinx-build -W docs/ docs/_build/ 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 install-docs-env: ## install libraries required to build docs
@pip install -r requirements-docs.txt @pip install -r requirements-docs.txt

12
README.md
View File

@@ -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") [![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") [![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") [![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") [![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://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") [![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. 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): 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 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. 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:** **Example 1:**
@@ -63,7 +63,7 @@ system when the container exits, but any changes made to the `~/work` directory
## Contributing ## 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 information about how to contribute package updates, recipes, features, tests, and community
maintained stacks. maintained stacks.
@@ -98,7 +98,7 @@ This change is tracked in the issue [#1217](https://github.com/jupyter/docker-st
## Alternatives ## 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 Jupyter-enabled Docker Images
- [openshift/source-to-image](https://github.com/openshift/source-to-image) - A tool for - [openshift/source-to-image](https://github.com/openshift/source-to-image) - A tool for
building/building artifacts from source and injecting into docker images 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 ## 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) - [Issue Tracker on GitHub](https://github.com/jupyter/docker-stacks)
- [Jupyter Discourse Forum](https://discourse.jupyter.org/) - [Jupyter Discourse Forum](https://discourse.jupyter.org/)
- [Jupyter Website](https://jupyter.org) - [Jupyter Website](https://jupyter.org)

2
docs/contributing/stacks.md
View File

@@ -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. 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. 2. Commit your changes and push to GitHub.
3. Head back to your repository and click on the **Actions** tab. 3. Head back to your repository and click on the **Actions** tab.

2
docs/maintaining/tasks.md
View File

@@ -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). [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. 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. 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 4. Create a new repository in the `jupyter` org on Docker Hub named after the stack folder in the
git repo. git repo.
5. Grant the `stacks` team permission to write to the repo. 5. Grant the `stacks` team permission to write to the repo.

2
docs/using/recipes.md
View File

@@ -69,7 +69,7 @@ RUN mamba install --yes --file /tmp/requirements.txt && \
fix-permissions "/home/${NB_USER}" 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 ## Add a Python 2.x environment

2
docs/using/running.md
View File

@@ -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. [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. You can use any of the Jupyter Docker Stacks images as a basis for a Binder-compatible Dockerfile.
See the 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 [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. [Binder documentation](https://mybinder.readthedocs.io/en/latest/index.html) for instructions.