Warn outdated recipes might be broken (#1954)

This commit is contained in:
Ayaz Salikhov
2023-07-28 18:42:00 +04:00
committed by GitHub
parent 5e381019fd
commit 3f257bdb4e
2 changed files with 56 additions and 5 deletions

View File

@@ -4,7 +4,8 @@ We welcome contributions of [recipes](../using/recipes.md), short examples of us
Follow the process below to add a new recipe:
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`)
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.
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Slideshows with JupyterLab and RISE`)
3. Write the body of your recipe under the heading, including whatever command line, links, etc. you need.
4. Please, put your Dockerfile in a `recipe_code` subfolder.
5. [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.

View File

@@ -46,6 +46,10 @@ docker build --rm -t my-custom-image .
## Add a custom conda environment and Jupyter kernel
```{warning}
This recipe is not tested and might be broken.
```
The default version of Python that ships with the image may not be the version you want.
The instructions below permit adding a conda environment with a different Python version and making it accessible to Jupyter.
@@ -106,6 +110,10 @@ docker run -it --rm \
## Let's Encrypt a Server
```{warning}
This recipe is not tested and might be broken.
```
See the README for a basic automation here
<https://github.com/jupyter/docker-stacks/tree/main/examples/make-deploy>
which includes steps for requesting and renewing a Let's Encrypt certificate.
@@ -133,6 +141,10 @@ You can find the original Jupyter Notebook extenstion [here](https://github.com/
## Running behind an nginx proxy
```{warning}
This recipe is not tested and might be broken.
```
Sometimes it is helpful to run the Jupyter instance behind an nginx proxy, for example:
- you would prefer to access the notebook at a server URL with a path
@@ -182,6 +194,10 @@ We also have contributed recipes for using JupyterHub.
### Use JupyterHub's dockerspawner
```{warning}
This recipe is not tested and might be broken.
```
In most cases for use with DockerSpawner, given an image that already has a notebook stack set up,
you would only need to add:
@@ -211,6 +227,10 @@ A few suggestions have been made regarding using Docker Stacks with spark.
### Using PySpark with AWS S3
```{warning}
This recipe is not tested and might be broken.
```
Using Spark session for Hadoop 2.7.3
```python
@@ -267,6 +287,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/127>
### Using Local Spark JARs
```{warning}
This recipe is not tested and might be broken.
```
```python
import os
@@ -291,6 +315,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/154>
### Using spark-packages.org
```{warning}
This recipe is not tested and might be broken.
```
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
@@ -300,6 +328,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/43>
### Use jupyter/all-spark-notebooks with an existing Spark/YARN cluster
```{warning}
This recipe is not tested and might be broken.
```
```dockerfile
FROM jupyter/all-spark-notebook
@@ -375,8 +407,6 @@ Credit: [britishbadger](https://github.com/britishbadger) from [docker-stacks/is
## Run Server inside an already secured environment (i.e., with no token)
(Adapted from [issue 728](https://github.com/jupyter/docker-stacks/issues/728))
The default security is very good.
There are use cases, encouraged by containers, where the jupyter container and the system it runs within lie inside the security boundary.
It is convenient to launch the server without a password or token in these use cases.
@@ -401,6 +431,10 @@ docker run -it --rm \
## Enable nbclassic-extension spellchecker for markdown (or any other nbclassic-extension)
```{warning}
This recipe is not tested and might be broken.
```
NB: this works for classic notebooks only
```dockerfile
@@ -420,6 +454,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/675>
## Enable Delta Lake in Spark notebooks
```{warning}
This recipe is not tested and might be broken.
```
Please note that the [Delta Lake](https://delta.io/) packages are only available for Spark version > `3.0`.
By adding the properties to `spark-defaults.conf`, the user no longer needs to enable Delta support in each notebook.
@@ -448,6 +486,10 @@ RUN echo "from pyspark.sql import SparkSession" > /tmp/init-delta.py && \
## Add Custom Fonts in Scipy notebook
```{warning}
This recipe is not tested and might be broken.
```
The example below is a Dockerfile to load Source Han Sans with normal weight, usually used for the web.
```dockerfile
@@ -465,6 +507,10 @@ RUN PYV=$(ls "${CONDA_DIR}/lib" | grep ^python) && \
## Enable clipboard in pandas on Linux systems
```{warning}
This recipe is not tested and might be broken.
```
```{admonition} Additional notes
This solution works on Linux host systems.
It is not required on Windows and won't work on macOS.
@@ -483,6 +529,10 @@ docker run -it --rm \
## Add ijavascript kernel to container
```{warning}
This recipe is not tested and might be broken.
```
The example below is a Dockerfile to install the [ijavascript kernel](https://github.com/n-riesco/ijavascript).
```dockerfile