mirror of
https://github.com/jupyter/docker-stacks.git
synced 2025-10-17 15:02:57 +00:00
Make markdown files look prettier using prettier :)
This commit is contained in:
Ayaz Salikhov
@@ -4,22 +4,22 @@ We appreciate your taking the time to report an issue you encountered using the
|
||||
Jupyter Docker Stacks. Please review the following guidelines when reporting
|
||||
your problem.
|
||||
|
||||
* If you believe you’ve found a security vulnerability in any of the Jupyter
|
||||
- If you believe you’ve found a security vulnerability in any of the Jupyter
|
||||
projects included in Jupyter Docker Stacks images, please report it to
|
||||
[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
|
||||
PGP public
|
||||
key](https://jupyter-notebook.readthedocs.io/en/stable/_downloads/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
|
||||
tracker](https://github.com/jupyter/docker-stacks/issues) to see if someone
|
||||
else has already reported the same problem. If not, please open a [new
|
||||
issue](https://github.com/jupyter/docker-stacks/issues/new) and provide all of
|
||||
the information requested in the issue template.
|
||||
* If the issue you're seeing is with one of the open source libraries included
|
||||
- If the issue you're seeing is with one of the open source libraries included
|
||||
in the Docker images and is reproducible outside the images, please file a bug
|
||||
with the appropriate open source project.
|
||||
* If you have a general question about how to use the Jupyter Docker Stacks in
|
||||
- If you have a general question about how to use the Jupyter Docker Stacks in
|
||||
your environment, in conjunction with other tools, with customizations, and so
|
||||
on, please post your question on the [Jupyter Discourse
|
||||
site](https://discourse.jupyter.org).
|
||||
|
||||
@@ -44,10 +44,10 @@ To comply with [Docker best practices][dbp], we are using the [Hadolint][hadolin
|
||||
Sometimes it is necessary to ignore [some rules][rules].
|
||||
The following rules are ignored by default for all images in the `.hadolint.yaml` file.
|
||||
|
||||
- [`DL3006`][DL3006]: We use a specific policy to manage image tags.
|
||||
- [`DL3006`][dl3006]: We use a specific policy to manage image tags.
|
||||
- `base-notebook` `FROM` clause is fixed but based on an argument (`ARG`).
|
||||
- Building downstream images from (`FROM`) the latest is done on purpose.
|
||||
- [`DL3008`][DL3008]: System packages are always updated (`apt-get`) to the latest version.
|
||||
- [`DL3008`][dl3008]: System packages are always updated (`apt-get`) to the latest version.
|
||||
|
||||
For other rules, the preferred way to do it is to flag ignored rules in the `Dockerfile`.
|
||||
|
||||
@@ -63,6 +63,6 @@ RUN cd /tmp && echo "hello!"
|
||||
[hadolint]: https://github.com/hadolint/hadolint
|
||||
[dbp]: https://docs.docker.com/develop/develop-images/dockerfile_best-practices
|
||||
[rules]: https://github.com/hadolint/hadolint#rules
|
||||
[DL3006]: https://github.com/hadolint/hadolint/wiki/DL3006
|
||||
[DL3008]: https://github.com/hadolint/hadolint/wiki/DL3008
|
||||
[dl3006]: https://github.com/hadolint/hadolint/wiki/DL3006
|
||||
[dl3008]: https://github.com/hadolint/hadolint/wiki/DL3008
|
||||
[pre-commit]: https://pre-commit.com/
|
||||
|
||||
@@ -80,27 +80,28 @@ The cookiecutter template comes with a `.github/workflows/docker.yml` file, whic
|
||||
```yaml
|
||||
on:
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- "*.md"
|
||||
- "binder/**"
|
||||
- "docs/**"
|
||||
- "examples/**"
|
||||
paths-ignore:
|
||||
- "*.md"
|
||||
- "binder/**"
|
||||
- "docs/**"
|
||||
- "examples/**"
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
paths-ignore:
|
||||
- "*.md"
|
||||
- "binder/**"
|
||||
- "docs/**"
|
||||
- "examples/**"
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
paths-ignore:
|
||||
- "*.md"
|
||||
- "binder/**"
|
||||
- "docs/**"
|
||||
- "examples/**"
|
||||
```
|
||||
|
||||
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.
|
||||
3. Head back to your repository and click on the **Actions** tab.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -123,17 +124,17 @@ you merge a GitHub pull request to the master branch of your project.
|
||||
9. Click on your avatar on the top-right corner and select Account settings.
|
||||
|
||||
10. Click on **Security** and then click on the **New Access Token** button.
|
||||
|
||||
|
||||
11. Enter a meaningful name for your token and click on **Create**
|
||||
|
||||
|
||||
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**.
|
||||
|
||||
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
|
||||
## Defining Your Image
|
||||
|
||||
@@ -151,7 +152,7 @@ master or main. Refer to Docker Cloud to build your master or main branch that y
|
||||
Finally, if you'd like to add a link to your project to this documentation site, please do the
|
||||
following:
|
||||
|
||||
1. Clone the [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks) GitHub repository.
|
||||
1. Clone the [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks) GitHub repository.
|
||||
2. Open the `docs/using/selecting.md` source file and locate the **Community Stacks** section.
|
||||
3. Add a bullet with a link to your project and a short description of what your Docker image contains.
|
||||
4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
|
||||
|
||||
@@ -3,5 +3,5 @@
|
||||
We are delighted when members of the Jupyter community want to help translate these documentation pages to other languages. If you're interested, please visit links below below to join our team on [Transifex](https://transifex.com) and to start creating, reviewing, and updating translations of the Jupyter Docker Stacks documentation.
|
||||
|
||||
1. Follow the steps documented on the [Getting Started as a Translator](https://docs.transifex.com/getting-started-1/translators) page.
|
||||
2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit <https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1> after creating your account and request to join the project.
|
||||
2. Look for _jupyter-docker-stacks_ when prompted to choose a translation team. Alternatively, visit <https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1> after creating your account and request to join the project.
|
||||
3. See [Translating with the Web Editor](https://docs.transifex.com/translation/translating-with-the-web-editor) in the Transifex documentation.
|
||||
|
||||
Reference in New Issue
Block a user