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

✏️ Fix typos

Browse Source
This commit is contained in:
Tania Allard
2021-04-13 11:13:45 +01:00
parent 26a46ca927
commit 7cf0a7710f
1 changed files with 14 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/contributing/stacks.md
View File

@@ -10,8 +10,7 @@ Following these steps will:
2. Configure GitHub Actions to build and test your image when users submit pull requests to your 2. Configure GitHub Actions to build and test your image when users submit pull requests to your
repository. repository.
3. Configure Docker Cloud to build and host your images for others to use. 3. Configure Docker Cloud to build and host your images for others to use.
4. Update the [list of community stacks](../using/selecting.html#community-stacks) in this 4. Update the [list of community stacks](../using/selecting.html#community-stacks) in this documentation to include your image.
documentation to include your image.
This approach mirrors how we build and share the core stack images. Feel free to follow it or pave This approach mirrors how we build and share the core stack images. Feel free to follow it or pave
your own path using alternative services and build tools. your own path using alternative services and build tools.
@@ -40,7 +39,7 @@ stack_name [my-jupyter-stack]:
``` ```
Enter the user or organization name under which this stack will reside on Docker Cloud / Hub. You Enter the user or organization name under which this stack will reside on Docker Cloud / Hub. You
must have access to manage this Docker Cloud org in order to push images here and setup automated must have access to manage this Docker Cloud org to push images here and set up automated
builds. builds.
``` ```
@@ -97,12 +96,12 @@ The cookiecutter template comes with a `.github/workflows/docker.yml` file, whic
- "examples/**" - "examples/**"
``` ```
This will trigger the CI pipeline whenever you push to your `main` or `master` branch and when any Pull Request are made to your repository. For more details on this configurations 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/../_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 be able to 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/../_static/github-actions-workflow.png)
## Configuring Docker Cloud ## Configuring Docker Cloud
@@ -127,35 +126,33 @@ you merge a GitHub pull request to the master branch of your project.
![Docker account Security settings screenshot](../_static/docker-org-security.png) ![Docker account Security settings screenshot](../_static/docker-org-security.png)
11. Enter a meaningful name for your token and click on **Create** 11. Enter a meaningful name for your token and click on **Create**
![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 in 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/../_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 token secret screenshot](../static/../_static/github-secret-token.png) ![GitHub create secret token screenshot](../static/../_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/../_static/github-secrets-completed.png)
## Defining Your Image ## Defining Your Image
Make edits the Dockerfile in your project to add third-party libraries and configure Jupyter Make edits to the Dockerfile in your project to add third-party libraries and configure Jupyter
applications. Refer to the Dockerfiles for the core stacks (e.g., applications. Refer to the Dockerfiles for the core stacks (e.g.,
[jupyter/datascience-notebook](https://github.com/jupyter/docker-stacks/blob/master/datascience-notebook/Dockerfile)) [jupyter/datascience-notebook](https://github.com/jupyter/docker-stacks/blob/master/datascience-notebook/Dockerfile))
to get a feel for what's possible and best practices. to get a feel for what's possible and best practices.
[Submit pull requests](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) [Submit pull requests](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
to your project repository on GitHub. Ensure your image builds properly on Travis before merging to to your project repository on GitHub. Ensure your image builds correctly on GitHub actions before merging to
master. Refer to Docker Cloud for builds of your master branch that you can `docker pull`. master or main. Refer to Docker Cloud to build your master or main branch that you can `docker pull`.
## Sharing Your Image ## Sharing Your Image
Finally, if you'd like to add a link to your project to this documentation site, please do the Finally, if you'd like to add a link to your project to this documentation site, please do the
following: following:
1. Clone ths [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. 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 3. Add a bullet with a link to your project and a short description of what your Docker image contains.
contains.
4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) 4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
(PR) with your changes. Maintainers will respond and work with you to address any formatting or (PR) with your changes. Maintainers will respond and work with you to address any formatting or content issues.
content issues.