Address code review comments, add screenshots

This commit is contained in:
Peter Parente
2018-06-03 20:58:17 -04:00
parent 0f9a9c2db2
commit 0ad2745a01
9 changed files with 22 additions and 18 deletions

BIN
docs/_static/docker-github-settings.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

BIN
docs/_static/docker-org-select.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

BIN
docs/_static/docker-repo-name.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

BIN
docs/_static/travis-build-settings.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
docs/_static/travis-enable-build.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/_static/travis-plus-repo.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

View File

@@ -166,5 +166,7 @@ texinfo_documents = [
'Miscellaneous'), 'Miscellaneous'),
] ]
# -- Extension configuration -------------------------------------------------
# Anchors are often dynamic
linkcheck_anchors = False

View File

@@ -5,5 +5,4 @@ We welcome contributions of [recipes](../using/recipes.html), short examples of
1. Open the `docs/using/recipes.md` source file. 1. Open the `docs/using/recipes.md` source file.
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension``) 2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension``)
3. Write the body of your recipe under the heading, including whatever command line, Dockerfile, links, etc. you need. 3. Write the body of your recipe under the heading, including whatever command line, Dockerfile, links, etc. you need.
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. 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 content issues.
5. Discuss changes with the maintainers and address any formatting or content issues.

View File

@@ -67,15 +67,17 @@ git push -u origin master
Next, link your GitHub project to Travis CI to build your Docker image whenever you or someone else submits a pull request. Next, link your GitHub project to Travis CI to build your Docker image whenever you or someone else submits a pull request.
1. Visit [https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI](https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI) 1. Visit [https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI](https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI) and follow the instructions to add the Travis CI application to your GitHub account.
2. Follow the instructions to add the Travis CI application to your GitHub account.
3. Visit [https://travis-ci.org](https://travis-ci.org). 3. Visit [https://travis-ci.org](https://travis-ci.org).
4. Click the + symbol on the left side. 4. Click the + symbol at the top of the left sidebar.
![Travis sidebar with plus button screenshot](../_static/travis-plus-repo.png)
5. Locate your project repository either in your primary user account or in one of the organizations to which you belong. 5. Locate your project repository either in your primary user account or in one of the organizations to which you belong.
6. Click the toggle to enable builds for the project repository. 6. Click the toggle to enable builds for the project repository.
7. Click the *Settings* button for that repository. 7. Click the **Settings** button for that repository.
8. Enable *Build only if .travis.yml is present* and *Build pushed pull requests*. ![Travis enable build toggle screenshot](../_static/travis-enable-build.png)
9. Disable *Build pushed branches*. 8. Enable **Build only if .travis.yml is present** and **Build pushed pull requests**.
![Travis build settings screenshot](../_static/travis-build-settings.png)
9. Disable **Build pushed branches**.
## Configuring Docker Cloud ## Configuring Docker Cloud
@@ -83,26 +85,27 @@ Now, configure Docker Cloud to build your stack image and push it to Docker Hub
1. Visit [https://cloud.docker.com/](https://cloud.docker.com/) and login. 1. Visit [https://cloud.docker.com/](https://cloud.docker.com/) and login.
2. Select the account or organization matching the one you entered when prompted with `stack_org` by the cookiecutter. 2. Select the account or organization matching the one you entered when prompted with `stack_org` by the cookiecutter.
3. Click *Create repository*. ![Docker account selection screenshot](../_static/docker-org-select.png)
3. Scroll to the bottom of the page and click **Create repository**.
4. Enter the name of the image matching the one you entered when prompted with `stack_name` by the cookiecutter. 4. Enter the name of the image matching the one you entered when prompted with `stack_name` by the cookiecutter.
![Docker image name and description screenshot](../_static/docker-repo-name.png)
5. Enter a description for your image. 5. Enter a description for your image.
6. Click *GitHub* under the *Build Settings* and follow the prompts to connect your account if it is not already connected. 6. Click **GitHub** under the **Build Settings** and follow the prompts to connect your account if it is not already connected.
7. Select the GitHub organization and repository containing your image definition from the dropdowns. 7. Select the GitHub organization and repository containing your image definition from the dropdowns.
8. Click the *Create and Build* button. ![Docker from GitHub automated build screenshot](../_static/docker-github-settings.png)
8. Click the **Create and Build** button.
## Defining Your Image ## Defining Your Image
Make edits the Dockerfile in your project to add third-party libraries and configure Jupyter 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)) to get a feel for what's possible and best practices. Make edits the Dockerfile in your project to add third-party libraries and configure Jupyter 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)) 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) to your project repository on GitHub. Ensure your image builds properly on Travis before merging to master. Refer to Docker Cloud for builds of your master branch that you can `docker pull`. [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 master. Refer to Docker Cloud for builds of your master 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 following: Finally, if you'd like to add a link to your project to this documentation site, please do the following:
0. Clone ths [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks) GitHub repository. 1. Clone ths [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks) GitHub repository.
1. Open the `docs/using/selecting.md` source file. 2. Open the `docs/using/selecting.md` source file and locate the **Community Stacks** section.
2. 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. 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) (PR) with your changes. 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 content issues.
5. Discuss changes with the maintainers and address any formatting or content issues.