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

Address most review comments by @jzf2101

Browse Source
This commit is contained in:
Peter Parente
2018-05-12 14:36:40 -04:00
parent 5b66283920
commit a82e51a17e
4 changed files with 13 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/issue_template.md vendored
View File

@@ -1,6 +1,6 @@
Hi! Thanks for using Jupyter's docker-stacks images. Hi! Thanks for using the Jupyter Docker Stacks.
If you are requesting a library upgrade or addition in one of the existing images, please state the desired library name and version here and disregard the remaining sections. If you are looking to contribute to the images, please see the [Contributor's Guide] (http://jupyter-docker-stacks.readthedocs.io/en/latest/#) in the documentation for our preferred processes.
If you are reporting an issue with one of the existing images, please answer the questions below to help us troubleshoot the problem. Please be as thorough as possible. If you are reporting an issue with one of the existing images, please answer the questions below to help us troubleshoot the problem. Please be as thorough as possible.

16
docs/contributing/features.md
View File

@@ -2,16 +2,16 @@
We review contributions of new features (e.g., new packages, new scripts, new flags) to the core stacks in an attempt to balance the value of the images to the Jupyter community with the cost of maintaining the images over time. Roughly speaking, we think about the following when considering additions: We review contributions of new features (e.g., new packages, new scripts, new flags) to the core stacks in an attempt to balance the value of the images to the Jupyter community with the cost of maintaining the images over time. Roughly speaking, we think about the following when considering additions:
* *Usefulness to Jupyter users* - Is the feature generally applicable across domains? Does it work with Jupyter Notebook, JupyterLab, JupyterHub, etc.? * **Usefulness to Jupyter users**: Is the feature generally applicable across domains? Does it work with Jupyter Notebook, JupyterLab, JupyterHub, etc.?
* *Fit with the image purpose* - Does the feature match the theme of the stack in which it will be added? Would it fit better in a new, community stack? * **Fit with the image purpose**: Does the feature match the theme of the stack in which it will be added? Would it fit better in a new, community stack?
* *Complexity of build / runtime configuration* - How many lines of code does the feature require in one of the Dockerfiles or startup scripts? Does it require new scripts entirely? Do users need to adjust how they use the images? * **Complexity of build / runtime configuration**: How many lines of code does the feature require in one of the Dockerfiles or startup scripts? Does it require new scripts entirely? Do users need to adjust how they use the images?
* *Impact on image metrics* - How many bytes does the feature and its dependencies add to the image(s)? How many minutes do they add to the build time? * **Impact on image metrics**: How many bytes does the feature and its dependencies add to the image(s)? How many minutes do they add to the build time?
* *Ability to support the addition* - Can existing maintainers answer user questions and address future build issues? Are the contributors interested in helping with long-term maintenance? Can we write tests to ensure the feature continues to work over time? * **Ability to support the addition**: Can existing maintainers answer user questions and address future build issues? Are the contributors interested in helping with long-term maintenance? Can we write tests to ensure the feature continues to work over time?
Follow the process below to suggest a new feature for inclusion in one of the core stacks: Please follow the process below to suggest a new feature for inclusion in one of the core stacks:
1. Open a GitHub issue describing the feature you'd like to contribute. 1. [Open a GitHub issue](https://github.com/jupyter/docker-stacks/issues) describing the feature you'd like to contribute.
2. Discuss whether the addition makes sense in [one of the core stacks](../using/selecting.html#Core-Stacks), as a [recipe in the documentation](recipes.html), as a [community stack](stacks.html), or as something else entirely. 2. Discuss with the maintainers whether the addition makes sense in [one of the core stacks](../using/selecting.html#Core-Stacks), as a [recipe in the documentation](recipes.html), as a [community stack](stacks.html), or as something else entirely.
If there's agreement that the feature belongs in one or more of the core stacks: If there's agreement that the feature belongs in one or more of the core stacks:

4
docs/contributing/packages.md
View File

@@ -1,8 +1,8 @@
# Package Updates # Package Updates
We welcome all contributions that update packages already included in the project Dockerfiles. Follow the process below to update a package version: We welcome all contributions that update packages already included in the project Dockerfiles. Please follow the process below to update a package version:
1. Locate the Dockerfile containing the library you wish to update. 1. Locate the Dockerfile containing the library you wish to update (e.g., [base-notebook/Dockerfile](https://github.com/jupyter/docker-stacks/blob/master/base-notebook/Dockerfile), [scipy-notebook/Dockerfile](https://github.com/jupyter/docker-stacks/blob/master/scipy-notebook/Dockerfile))
2. Adjust the version number for the package. 2. Adjust the version number for the package.
* We prefer to pin the major and minor version number of packages so as to minimize rebuild side-effects when users submit pull requests (PRs). For example, you'll find the Jupyter Notebook package, `notebook`, installed using conda with `notebook=5.4.*`. * We prefer to pin the major and minor version number of packages so as to minimize rebuild side-effects when users submit pull requests (PRs). For example, you'll find the Jupyter Notebook package, `notebook`, installed using conda with `notebook=5.4.*`.
3. Try to build the image locally (`make image/somestack-notebook`) before submitting a pull request. 3. Try to build the image locally (`make image/somestack-notebook`) before submitting a pull request.

6
docs/using/recipes.md
View File

@@ -28,7 +28,7 @@ Here is a [quick example NGINX configuration](https://gist.github.com/cboettig/8
## Using spark-packages.org ## Using spark-packages.org
If you'd like to use packages from spark-packages.org, see [https://gist.github.com/parente/c95fdaba5a9a066efaab](https://gist.github.com/parente/c95fdaba5a9a066efaab) for an example of how to specify the package identifier in the environment before creating a SparkContext. If you'd like to use packages from [spark-packages.org](https://spark-packages.org/), see [https://gist.github.com/parente/c95fdaba5a9a066efaab](https://gist.github.com/parente/c95fdaba5a9a066efaab) for an example of how to specify the package identifier in the environment before creating a SparkContext.
Ref: [https://github.com/jupyter/docker-stacks/issues/43](https://github.com/jupyter/docker-stacks/issues/43) Ref: [https://github.com/jupyter/docker-stacks/issues/43](https://github.com/jupyter/docker-stacks/issues/43)
@@ -38,10 +38,6 @@ See the README for the simple automation here [https://github.com/jupyter/docker
Ref: [https://github.com/jupyter/docker-stacks/issues/78](https://github.com/jupyter/docker-stacks/issues/78) Ref: [https://github.com/jupyter/docker-stacks/issues/78](https://github.com/jupyter/docker-stacks/issues/78)
## Add Incubating Dashboard, Declarative Widget, Content Management Extensions
Create a new Dockerfile like the one shown in this gist: [https://gist.github.com/parente/0d735d93cb81a582d635](https://gist.github.com/parente/0d735d93cb81a582d635). Switch the base stack image to whichever you please (e.g., `FROM jupyter/datascience-notebook`, `FROM jupyter/pyspark-notebook`).
## Using `pip install` in a Child Docker image ## Using `pip install` in a Child Docker image
Create a new Dockerfile like the one shown below. Create a new Dockerfile like the one shown below.