From 5d2e424a1205d95928ba57de62ad626677da7c5b Mon Sep 17 00:00:00 2001 From: ahgraber Date: Sat, 18 Mar 2023 11:48:23 -0400 Subject: [PATCH] push deprecation warning to dockerhub readme --- .editorconfig | 3 +++ .github/workflows/1-build-stack.yaml | 1 + .github/workflows/hub-overview.yaml | 4 ++-- README.md | 3 ++- src/base-env/README.md | 6 ++++++ src/ds-env/README.md | 6 ++++++ src/nlp-env/README.md | 6 ++++++ src/ts-env/README.md | 6 ++++++ src/web-env/README.md | 6 ++++++ 9 files changed, 38 insertions(+), 3 deletions(-) diff --git a/.editorconfig b/.editorconfig index 586c736..da447cf 100644 --- a/.editorconfig +++ b/.editorconfig @@ -13,6 +13,9 @@ charset = utf-8 [*.{bat,cmd,ps1}] end_of_line = crlf +[*.md] +trim_trailing_whitespace = false + [*.{yml,yaml}] indent_size = 2 diff --git a/.github/workflows/1-build-stack.yaml b/.github/workflows/1-build-stack.yaml index d928697..6467919 100644 --- a/.github/workflows/1-build-stack.yaml +++ b/.github/workflows/1-build-stack.yaml @@ -14,6 +14,7 @@ on: # yamllint disable-line rule:truthy pull_request: paths-ignore: # - ".github/**" + - .github/workflows/hub-overview.yaml - docs/** - scripts/** - '*.md' diff --git a/.github/workflows/hub-overview.yaml b/.github/workflows/hub-overview.yaml index 832e575..ffeb6e3 100644 --- a/.github/workflows/hub-overview.yaml +++ b/.github/workflows/hub-overview.yaml @@ -6,7 +6,7 @@ on: # yamllint disable-line rule:truthy branches: - main paths: - - ".github/workflows/hub-overview.yml" + - ".github/workflows/hub-overview.yaml" - "src/base-env/README.md" - "src/ds-env/README.md" @@ -32,7 +32,7 @@ jobs: Customized version of jupyter/minimal-notebook - image: ds-env description: | - Base image from ninerealmlabs/docker-jupyter-stacks with 'standard' data & analytics pacakges + Base image from ninerealmlabs/docker-jupyter-stacks with 'standard' data & analytics packages - image: nlp-env description: | Environment from ninerealmlabs/docker-jupyter-stacks for nlp & text analysis diff --git a/README.md b/README.md index e8d219e..f9c6397 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,9 @@ This repo contains the source files for juptyer containers based on [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks). > ⚠️ Deprecation Notice: No longer updating Dockerhub repository ⚠️ +> > Due to March 2023 removal of Docker's free Teams organization & history of price changes, -> images will no longer be pushed to DockerHub. +> images will no longer be pushed to DockerHub. > Please use `ghcr.io/ninerealmlabs/:` - [Introduction](#introduction) diff --git a/src/base-env/README.md b/src/base-env/README.md index fad50b1..1d6c24f 100755 --- a/src/base-env/README.md +++ b/src/base-env/README.md @@ -1,5 +1,11 @@ # Base +> ⚠️ Deprecation Notice: No longer updating Dockerhub repository ⚠️ +> +> Due to March 2023 removal of Docker's free Teams organization & history of price changes, +> images will no longer be pushed to DockerHub. +> Please use `ghcr.io/ninerealmlabs/:` + JupyterLab environment designed as a base image. Built from [jupyter/docker-stacks/minimal-notebook](https://github.com/jupyter/docker-stacks/tree/master/minimal-notebook), with additional customization to the "jupyterhub OS" to allow multiple environments, diff --git a/src/ds-env/README.md b/src/ds-env/README.md index 18bc44c..e29ab10 100644 --- a/src/ds-env/README.md +++ b/src/ds-env/README.md @@ -1,5 +1,11 @@ # Data Science Environment +> ⚠️ Deprecation Notice: No longer updating Dockerhub repository ⚠️ +> +> Due to March 2023 removal of Docker's free Teams organization & history of price changes, +> images will no longer be pushed to DockerHub. +> Please use `ghcr.io/ninerealmlabs/:` + JupyterLab environment designed for general data analysis and ML, including a variety of libraries for plotting, missing and imbalanced data management, connections to databases. Of particular interest might be [`dataprep`](https://github.com/sfu-db/dataprep). diff --git a/src/nlp-env/README.md b/src/nlp-env/README.md index f251f04..b22c562 100644 --- a/src/nlp-env/README.md +++ b/src/nlp-env/README.md @@ -1,5 +1,11 @@ # NLP Environment +> ⚠️ Deprecation Notice: No longer updating Dockerhub repository ⚠️ +> +> Due to March 2023 removal of Docker's free Teams organization & history of price changes, +> images will no longer be pushed to DockerHub. +> Please use `ghcr.io/ninerealmlabs/:` + JupyterLab environment updated to include packages useful for Natural Language Processing (NLP) tasks like `NLTK`, `Gensim`, `HuggingFace`, and `SpaCy`. diff --git a/src/ts-env/README.md b/src/ts-env/README.md index 1b252a2..fe46ed8 100644 --- a/src/ts-env/README.md +++ b/src/ts-env/README.md @@ -1,5 +1,11 @@ # Time Series environment +> ⚠️ Deprecation Notice: No longer updating Dockerhub repository ⚠️ +> +> Due to March 2023 removal of Docker's free Teams organization & history of price changes, +> images will no longer be pushed to DockerHub. +> Please use `ghcr.io/ninerealmlabs/:` + JupyterLab environment with packages for forecasting and time-series data analysis, like `prophet`, `pywavelets`, `stumpy`, and `u8darts`. diff --git a/src/web-env/README.md b/src/web-env/README.md index ff34695..34b5203 100644 --- a/src/web-env/README.md +++ b/src/web-env/README.md @@ -1,5 +1,11 @@ # Web Environment +> ⚠️ Deprecation Notice: No longer updating Dockerhub repository ⚠️ +> +> Due to March 2023 removal of Docker's free Teams organization & history of price changes, +> images will no longer be pushed to DockerHub. +> Please use `ghcr.io/ninerealmlabs/:` + JupyterLab environment that includes packages useful when modeling web traffic and behavior or web scraping. This image also includes `chrome`/`chromedriver` and `firefox`/`geckodriver`.