hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-12 04:22:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1295 from mathbunnyru/asalikhov/fix_dead_links

Browse Source 
Fix dead links in docs
This commit is contained in:
Erik Sundell
2021-05-19 03:41:06 +02:00
committed by GitHub
parent cf9a75c297 b748228e7e
commit c617f4491a
6 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/features.md
View File

@@ -11,7 +11,7 @@ Please follow the process below to suggest a new feature for inclusion in one of
1. [Open a GitHub issue](https://github.com/jupyter/docker-stacks/issues) describing the feature 1. [Open a GitHub issue](https://github.com/jupyter/docker-stacks/issues) describing the feature
you'd like to contribute. you'd like to contribute.
2. Discuss with the maintainers whether the addition makes sense in 2. Discuss with the maintainers whether the addition makes sense in
[one of the core stacks](../using/selecting.md#Core-Stacks), as a [one of the core stacks](../using/selecting.md#core-stacks), as a
[recipe in the documentation](recipes.md), as a [community stack](stacks.md), or as something [recipe in the documentation](recipes.md), as a [community stack](stacks.md), or as something
else entirely. else entirely.

2
docs/contributing/issues.md
View File

@@ -9,7 +9,7 @@ your problem.
[security@ipython.org](mailto:security@iypthon.org), not in the issue trackers [security@ipython.org](mailto:security@iypthon.org), not in the issue trackers
on GitHub. If you prefer to encrypt your security reports, you can use [this on GitHub. If you prefer to encrypt your security reports, you can use [this
PGP public PGP public
key](https://jupyter-notebook.readthedocs.io/en/stable/_downloads/ipython_security.asc). key](https://github.com/jupyter/jupyter.github.io/blob/master/assets/ipython_security.asc).
* If you think your problem is unique to the Jupyter Docker Stacks images, * If you think your problem is unique to the Jupyter Docker Stacks images,
please search the [jupyter/docker-stacks issue please search the [jupyter/docker-stacks issue
tracker](https://github.com/jupyter/docker-stacks/issues) to see if someone tracker](https://github.com/jupyter/docker-stacks/issues) to see if someone

12
docs/contributing/stacks.md
View File

@@ -17,7 +17,7 @@ your own path using alternative services and build tools.
## Creating a Project ## Creating a Project
First, install [cookiecutter](https://github.com/audreyr/cookiecutter) using pip or conda: First, install [cookiecutter](https://github.com/cookiecutter/cookiecutter) using pip or conda:
```bash ```bash
pip install cookiecutter # or conda install cookiecutter pip install cookiecutter # or conda install cookiecutter
@@ -99,10 +99,10 @@ 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). 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).
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.
![GitHub actions tab screenshot](../static/../_static/github-actions-tab.png) ![GitHub actions tab screenshot](../_static/github-actions-tab.png)
From there, you can click on the workflows on the left-hand side of the screen. From there, you can click on the workflows on the left-hand side of the screen.
4. In the next screen, you will be able to see information about the workflow run and duration. If you click again on the button with the workflow name, you will see the logs for the workflow steps. 4. In the next screen, you will be able to see information about the workflow run and duration. If you click again on the button with the workflow name, you will see the logs for the workflow steps.
![Github actions workflow run screenshot](../static/../_static/github-actions-workflow.png) ![Github actions workflow run screenshot](../_static/github-actions-workflow.png)
## Configuring Docker Cloud ## Configuring Docker Cloud
@@ -128,12 +128,12 @@ you merge a GitHub pull request to the master branch of your project.
![Docker account create new token screenshot](../_static/docker-org-create-token.png) ![Docker account create new token screenshot](../_static/docker-org-create-token.png)
12. Copy the personal access token displayed on the next screen. **Note that you will not be able to see it again after you close the pop-up window**. 12. Copy the personal access token displayed on the next screen. **Note that you will not be able to see it again after you close the pop-up window**.
13. Head back to your GitHub repository and click on the **Settings tab**. 13. Head back to your GitHub repository and click on the **Settings tab**.
![Github repository settings tab screenshot](../static/../_static/github-create-secrets.png) ![Github repository settings tab screenshot](../_static/github-create-secrets.png)
14. Click on the **Secrets** section and then on the **New repository secret** button on the top right corner (see image above). 14. Click on the **Secrets** section and then on the **New repository secret** button on the top right corner (see image above).
15. Create a **DOCKERHUB_TOKEN** secret and paste the Personal Access Token from DockerHub in the **value** field. 15. Create a **DOCKERHUB_TOKEN** secret and paste the Personal Access Token from DockerHub in the **value** field.
![GitHub create secret token screenshot](../static/../_static/github-secret-token.png) ![GitHub create secret token screenshot](../_static/github-secret-token.png)
16. Repeat the above step but creating a **DOCKERHUB_USERNAME** and replacing the *value* field with your DockerHub username. Once you have completed these steps, your repository secrets section should look something like this: 16. Repeat the above step but creating a **DOCKERHUB_USERNAME** and replacing the *value* field with your DockerHub username. Once you have completed these steps, your repository secrets section should look something like this:
![GitHub repository secrets created screenshot](../static/../_static/github-secrets-completed.png) ![GitHub repository secrets created screenshot](../_static/github-secrets-completed.png)
## Defining Your Image ## Defining Your Image

2
docs/contributing/tests.md
View File

@@ -10,7 +10,7 @@ repository. This `make` command builds every docker image. After building each i
command executes `pytest` to run both image-specific tests like those in command executes `pytest` to run both image-specific tests like those in
[base-notebook/test/](https://github.com/jupyter/docker-stacks/tree/master/base-notebook/test) and [base-notebook/test/](https://github.com/jupyter/docker-stacks/tree/master/base-notebook/test) and
common tests defined in [test/](https://github.com/jupyter/docker-stacks/tree/master/test). Both common tests defined in [test/](https://github.com/jupyter/docker-stacks/tree/master/test). Both
kinds of tests make use of global [pytest fixtures](https://docs.pytest.org/en/latest/fixture.html) kinds of tests make use of global [pytest fixtures](https://docs.pytest.org/en/latest/reference/fixtures.html)
defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/master/conftest.py) file defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/master/conftest.py) file
at the root of the projects. at the root of the projects.

2
docs/using/common.md
View File

@@ -6,7 +6,7 @@ This page describes the options supported by the startup script as well as how t
## Notebook Options ## Notebook Options
You can pass [Jupyter command line options](https://jupyter.readthedocs.io/en/latest/projects/jupyter-command.html) to the `start-notebook.sh` script when launching the container. For example, to secure the Notebook server with a custom password hashed using `IPython.lib.passwd()` instead of the default token, you can run the following: You can pass [Jupyter command line options](https://jupyter-notebook.readthedocs.io/en/stable/config.html#options) to the `start-notebook.sh` script when launching the container. For example, to secure the Notebook server with a custom password hashed using `IPython.lib.passwd()` instead of the default token, you can run the following:
```bash ```bash
docker run -d -p 8888:8888 jupyter/base-notebook start-notebook.sh --NotebookApp.password='sha1:74ba40f8a388:c913541b7ee99d15d5ed31d4226bf7838f83a50e' docker run -d -p 8888:8888 jupyter/base-notebook start-notebook.sh --NotebookApp.password='sha1:74ba40f8a388:c913541b7ee99d15d5ed31d4226bf7838f83a50e'

4
docs/using/selecting.md
View File

@@ -51,7 +51,7 @@ and versioning strategy.
- Everything in `jupyter/base-notebook` - Everything in `jupyter/base-notebook`
- [TeX Live](https://www.tug.org/texlive/) for notebook document conversion - [TeX Live](https://www.tug.org/texlive/) for notebook document conversion
- [git](https://git-scm.com/), - [git](https://git-scm.com/),
[vi](https://vim.org/) (actually `vim-tiny`), [vi](https://www.vim.org) (actually `vim-tiny`),
[nano](https://www.nano-editor.org/) (actually `nano-tiny`), tzdata, and unzip [nano](https://www.nano-editor.org/) (actually `nano-tiny`), tzdata, and unzip
### jupyter/r-notebook ### jupyter/r-notebook
@@ -158,7 +158,7 @@ communities.
- [Apache Toree](https://toree.apache.org/) and - [Apache Toree](https://toree.apache.org/) and
[spylon-kernel](https://github.com/maxpoint/spylon-kernel) to support Scala code in Jupyter [spylon-kernel](https://github.com/maxpoint/spylon-kernel) to support Scala code in Jupyter
notebooks notebooks
- [ggplot2](http://ggplot2.org/), [sparklyr](http://spark.rstudio.com/), and - [ggplot2](https://ggplot2.tidyverse.org), [sparklyr](http://spark.rstudio.com/), and
[rcurl](https://cran.r-project.org/web/packages/RCurl/index.html) packages [rcurl](https://cran.r-project.org/web/packages/RCurl/index.html) packages
### Image Relationships ### Image Relationships