@@ -5,5 +5,4 @@ We welcome contributions of [recipes](../using/recipes.html), short examples of
...
@@ -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.
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. 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.
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.
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:
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.
