Fix custom conda environment recipe

.github/workflows/contributed-recipes.yml

@@ -38,6 +38,7 @@ jobs:
       matrix:
         dockerfile:
           [
+            custom_environment.dockerfile,
             dask_jupyterlab.dockerfile,
             jupyterhub_version.dockerfile,
             mamba_install.dockerfile,

docs/using/recipe_code/custom_environment.dockerfile

@@ -0,0 +1,33 @@
+FROM jupyter/base-notebook
+
+# name your environment and choose the python version
+ARG env_name=python38
+ARG py_ver=3.8
+
+# you can add additional libraries here
+RUN mamba create --yes -p "${CONDA_DIR}/envs/${env_name}" \
+    python=${py_ver} \
+    'ipykernel' \
+    'jupyterlab' && \
+    mamba clean --all -f -y
+
+# alternatively, you can comment out the lines above and uncomment those below
+# if you'd prefer to use a YAML file present in the docker build context
+
+# COPY --chown=${NB_UID}:${NB_GID} environment.yml /tmp/
+# RUN mamba env create -p "${CONDA_DIR}/envs/${env_name}" -f /tmp/environment.yml && \
+#     mamba clean --all -f -y
+
+# create Python kernel and link it to jupyter
+RUN "${CONDA_DIR}/envs/${env_name}/bin/python" -m ipykernel install --user --name="${env_name}" && \
+    fix-permissions "${CONDA_DIR}" && \
+    fix-permissions "/home/${NB_USER}"
+
+# any additional `pip` installs can be added by using the following line
+# using `mamba` is highly recommended
+RUN "${CONDA_DIR}/envs/${env_name}/bin/pip" install --no-cache-dir \
+    'flake8'
+
+# if you do not want this environment to be the default one, comment this line
+# hadolint ignore=DL3059
+RUN echo "conda activate ${env_name}" >> "${HOME}/.bashrc"

docs/using/recipes.md

@@ -46,42 +46,13 @@ docker build --rm --tag 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.
+You may also use older image like `jupyter/base-notebook:python-3.10`.
+List of all tags can be found [here](https://github.com/jupyter/docker-stacks/wiki)
 
-```dockerfile
+```{literalinclude} recipe_code/custom_environment.dockerfile
-FROM jupyter/minimal-notebook
+:language: docker
-
-# name your environment and choose the python version
-ARG conda_env=python37
-ARG py_ver=3.7
-
-# you can add additional libraries you want mamba to install by listing them below the first line and ending with "&& \"
-RUN mamba create --yes -p "${CONDA_DIR}/envs/${conda_env}" python=${py_ver} ipython ipykernel && \
-    mamba clean --all -f -y
-
-# alternatively, you can comment out the lines above and uncomment those below
-# if you'd prefer to use a YAML file present in the docker build context
-
-# COPY --chown=${NB_UID}:${NB_GID} environment.yml "/home/${NB_USER}/tmp/"
-# RUN cd "/home/${NB_USER}/tmp/" && \
-#     mamba env create -p "${CONDA_DIR}/envs/${conda_env}" -f environment.yml && \
-#     mamba clean --all -f -y
-
-# create Python kernel and link it to jupyter
-RUN "${CONDA_DIR}/envs/${conda_env}/bin/python" -m ipykernel install --user --name="${conda_env}" && \
-    fix-permissions "${CONDA_DIR}" && \
-    fix-permissions "/home/${NB_USER}"
-
-# any additional pip installs can be added by uncommenting the following line
-# RUN "${CONDA_DIR}/envs/${conda_env}/bin/pip" install --no-cache-dir
-
-# if you want this environment to be the default one, uncomment the following line:
-# RUN echo "conda activate ${conda_env}" >> "${HOME}/.bashrc"
 ```
 
 ## Dask JupyterLab Extension