From 232b84a865d8e56992b22b2141aa1bd01174599e Mon Sep 17 00:00:00 2001 From: Michael McQuade Date: Wed, 4 Mar 2026 18:14:37 -0600 Subject: [PATCH] docs: fix broken images, use relative links --- workflow/readmes/jupyter-host/cloud.md | 3 +-- workflow/readmes/jupyter-host/emed-onprem.md | 2 +- workflow/readmes/jupyter-host/podmt3.md | 2 +- workflow/readmes/jupyter-host/workdir.md | 2 +- workflow/readmes/jupyterlab-host/general.md | 8 +++++--- workflow/readmes/jupyterlab-host/general_k8s.md | 8 +++++--- workflow/readmes/openvscode/cloud.md | 2 +- workflow/readmes/openvscode/emed-onprem.md | 2 +- workflow/readmes/openvscode/general_k8s.md | 2 +- workflow/readmes/openvscode/noaa-onprem.md | 2 +- workflow/readmes/vncserver/armforge.md | 2 +- workflow/readmes/vncserver/firefox.md | 2 +- workflow/readmes/vncserver/fsl.md | 2 +- workflow/readmes/vncserver/general.md | 2 +- workflow/readmes/vncserver/general_k8s.md | 2 +- workflow/readmes/vncserver/matlab.md | 2 +- workflow/readmes/vncserver/matlab_k8s.md | 2 +- workflow/readmes/vncserver/rstudio.md | 2 +- workflow/readmes/vncserver/rstudio_k8s.md | 2 +- workflow/readmes/vncserver/schrodinger.md | 2 +- workflow/readmes/vncserver/vmd.md | 2 +- workflow/readmes/webshell/noaa-onprem.md | 2 +- 22 files changed, 30 insertions(+), 27 deletions(-) diff --git a/workflow/readmes/jupyter-host/cloud.md b/workflow/readmes/jupyter-host/cloud.md index f40c5bd88..ef41a2d7a 100644 --- a/workflow/readmes/jupyter-host/cloud.md +++ b/workflow/readmes/jupyter-host/cloud.md @@ -1,3 +1,2 @@ ## Jupyter Interactive Session -This workflow starts a Jupyter Notebook server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). -This is a description test +This workflow starts a Jupyter Notebook server [interactive session](../../../README.md). diff --git a/workflow/readmes/jupyter-host/emed-onprem.md b/workflow/readmes/jupyter-host/emed-onprem.md index 7b494e204..190f6bd05 100644 --- a/workflow/readmes/jupyter-host/emed-onprem.md +++ b/workflow/readmes/jupyter-host/emed-onprem.md @@ -1,3 +1,3 @@ ## Jupyter Interactive Session -This workflow starts a Jupyter Notebook server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). +This workflow starts a Jupyter Notebook server [interactive session](../../../README.md). diff --git a/workflow/readmes/jupyter-host/podmt3.md b/workflow/readmes/jupyter-host/podmt3.md index bca0682f3..1399b33cf 100644 --- a/workflow/readmes/jupyter-host/podmt3.md +++ b/workflow/readmes/jupyter-host/podmt3.md @@ -1,3 +1,3 @@ ## Jupyter Interactive Session -This workflow starts a Jupyter Notebook server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) in the POD MT3 cluster. +This workflow starts a Jupyter Notebook server [interactive session](../../../README.md) in the POD MT3 cluster. diff --git a/workflow/readmes/jupyter-host/workdir.md b/workflow/readmes/jupyter-host/workdir.md index 7b494e204..190f6bd05 100644 --- a/workflow/readmes/jupyter-host/workdir.md +++ b/workflow/readmes/jupyter-host/workdir.md @@ -1,3 +1,3 @@ ## Jupyter Interactive Session -This workflow starts a Jupyter Notebook server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). +This workflow starts a Jupyter Notebook server [interactive session](../../../README.md). diff --git a/workflow/readmes/jupyterlab-host/general.md b/workflow/readmes/jupyterlab-host/general.md index bad549f83..24d308578 100644 --- a/workflow/readmes/jupyterlab-host/general.md +++ b/workflow/readmes/jupyterlab-host/general.md @@ -1,5 +1,5 @@ ## JupyterLab Interactive Session -This workflow starts a JupyterLab server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). +This workflow starts a JupyterLab server [interactive session](../../../README.md). ### Dask Integration on Parallel Works @@ -9,5 +9,7 @@ Refer to the included Jupyter notebook at `jupyterlab-host/dask-extension-jupyte 2. Data transfer to and from a PW storage resource, corresponding to an AWS S3 bucket. Authentication is streamlined through short-term credentials. 3. Integration of the [Dask extension for JupyterLab](https://github.com/dask/dask-labextension) -A sample YAML file outlining Dask dependencies for PW is provided at `jupyterlab-host/dask-extension-jupyterlab.yaml`. These dependencies are automatically installed by selecting the input form parameters displayed in this [screenshot](https://raw.githubusercontent.com/parallelworks/interactive_session/jupyterlab-yaml-file/workflow/readmes/jupyterlab-host/dask-input-form.png). Alternatively, you have the option to use your own YAML file. - +A sample YAML file outlining Dask dependencies for PW is provided at `jupyterlab-host/dask-extension-jupyterlab.yaml`. These dependencies are automatically installed by selecting the input form parameters displayed in the screenshot below. Alternatively, you have the option to use your own YAML file. + +![Dask input form](dask-input-form.png) + diff --git a/workflow/readmes/jupyterlab-host/general_k8s.md b/workflow/readmes/jupyterlab-host/general_k8s.md index c26e8686c..217cf9e4a 100644 --- a/workflow/readmes/jupyterlab-host/general_k8s.md +++ b/workflow/readmes/jupyterlab-host/general_k8s.md @@ -1,5 +1,5 @@ # JupyterLab Interactive Session -This workflow starts a JupyterLab server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md), on either a **Compute Cluster** (SLURM or PBS) or a **Kubernetes Cluster**. +This workflow starts a JupyterLab server [interactive session](../../../README.md), on either a **Compute Cluster** (SLURM or PBS) or a **Kubernetes Cluster**. Use the `Target Type` input to select your environment. @@ -14,8 +14,10 @@ Refer to the included Jupyter notebook at `jupyterlab-host/dask-extension-jupyte 2. Data transfer to and from a PW storage resource, corresponding to an AWS S3 bucket. Authentication is streamlined through short-term credentials. 3. Integration of the [Dask extension for JupyterLab](https://github.com/dask/dask-labextension) -A sample YAML file outlining Dask dependencies for PW is provided at `jupyterlab-host/dask-extension-jupyterlab.yaml`. These dependencies are automatically installed by selecting the input form parameters displayed in this [screenshot](https://raw.githubusercontent.com/parallelworks/interactive_session/jupyterlab-yaml-file/workflow/readmes/jupyterlab-host/dask-input-form.png). Alternatively, you have the option to use your own YAML file. - +A sample YAML file outlining Dask dependencies for PW is provided at `jupyterlab-host/dask-extension-jupyterlab.yaml`. These dependencies are automatically installed by selecting the input form parameters displayed in the screenshot below. Alternatively, you have the option to use your own YAML file. + +![Dask input form](dask-input-form.png) + ## Kubernetes Cluster diff --git a/workflow/readmes/openvscode/cloud.md b/workflow/readmes/openvscode/cloud.md index ec19696af..730d95924 100644 --- a/workflow/readmes/openvscode/cloud.md +++ b/workflow/readmes/openvscode/cloud.md @@ -1,3 +1,3 @@ ## OpenVSCode Interactive Session -This workflow starts an OpenVSCode server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). +This workflow starts an OpenVSCode server [interactive session](../../../README.md). diff --git a/workflow/readmes/openvscode/emed-onprem.md b/workflow/readmes/openvscode/emed-onprem.md index ec19696af..730d95924 100644 --- a/workflow/readmes/openvscode/emed-onprem.md +++ b/workflow/readmes/openvscode/emed-onprem.md @@ -1,3 +1,3 @@ ## OpenVSCode Interactive Session -This workflow starts an OpenVSCode server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). +This workflow starts an OpenVSCode server [interactive session](../../../README.md). diff --git a/workflow/readmes/openvscode/general_k8s.md b/workflow/readmes/openvscode/general_k8s.md index 47a9b5941..81a6276c5 100644 --- a/workflow/readmes/openvscode/general_k8s.md +++ b/workflow/readmes/openvscode/general_k8s.md @@ -1,5 +1,5 @@ # OpenVSCode Interactive Session -This workflow starts an OpenVSCode server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md), on either a **Compute Cluster** (SLURM or PBS) or a **Kubernetes Cluster**. +This workflow starts an OpenVSCode server [interactive session](../../../README.md), on either a **Compute Cluster** (SLURM or PBS) or a **Kubernetes Cluster**. Use the `Target Type` input to select your environment. diff --git a/workflow/readmes/openvscode/noaa-onprem.md b/workflow/readmes/openvscode/noaa-onprem.md index ec19696af..730d95924 100644 --- a/workflow/readmes/openvscode/noaa-onprem.md +++ b/workflow/readmes/openvscode/noaa-onprem.md @@ -1,3 +1,3 @@ ## OpenVSCode Interactive Session -This workflow starts an OpenVSCode server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). +This workflow starts an OpenVSCode server [interactive session](../../../README.md). diff --git a/workflow/readmes/vncserver/armforge.md b/workflow/readmes/vncserver/armforge.md index 1020a9b30..fd518d5f8 100644 --- a/workflow/readmes/vncserver/armforge.md +++ b/workflow/readmes/vncserver/armforge.md @@ -1,5 +1,5 @@ ## Arm FORGE Interactive Session -This workflow launches Arm FORGE in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). +This workflow launches Arm FORGE in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/vncserver/firefox.md b/workflow/readmes/vncserver/firefox.md index 2e9738987..b3ca61a78 100644 --- a/workflow/readmes/vncserver/firefox.md +++ b/workflow/readmes/vncserver/firefox.md @@ -1,5 +1,5 @@ ## Firefox Interactive Session -This workflow launches Firefox in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). +This workflow launches Firefox in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/vncserver/fsl.md b/workflow/readmes/vncserver/fsl.md index 0bf17cff8..2ce49226b 100644 --- a/workflow/readmes/vncserver/fsl.md +++ b/workflow/readmes/vncserver/fsl.md @@ -1,5 +1,5 @@ ## FSL Interactive Session -This workflow launches FSL in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). +This workflow launches FSL in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/vncserver/general.md b/workflow/readmes/vncserver/general.md index fa901fde8..c56d2fc7f 100644 --- a/workflow/readmes/vncserver/general.md +++ b/workflow/readmes/vncserver/general.md @@ -1,4 +1,4 @@ ## Desktop Interactive Session -This workflow starts a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser. +This workflow starts a remote desktop [interactive session](../../../README.md) accessible via a web browser. It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/vncserver/general_k8s.md b/workflow/readmes/vncserver/general_k8s.md index 1b515f276..f04b89ed0 100644 --- a/workflow/readmes/vncserver/general_k8s.md +++ b/workflow/readmes/vncserver/general_k8s.md @@ -1,5 +1,5 @@ ## Desktop Interactive Session -This workflow starts a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser, on either a **Compute Cluster** (SLURM or PBS) or a **Kubernetes Cluster**. +This workflow starts a remote desktop [interactive session](../../../README.md) accessible via a web browser, on either a **Compute Cluster** (SLURM or PBS) or a **Kubernetes Cluster**. Use the `Target Type` input to select your environment. diff --git a/workflow/readmes/vncserver/matlab.md b/workflow/readmes/vncserver/matlab.md index 172f259a3..2f944af1b 100644 --- a/workflow/readmes/vncserver/matlab.md +++ b/workflow/readmes/vncserver/matlab.md @@ -1,5 +1,5 @@ ## MATLAB Interactive Session -This workflow launches MATLAB in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). +This workflow launches MATLAB in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/vncserver/matlab_k8s.md b/workflow/readmes/vncserver/matlab_k8s.md index 4efe9fa7b..4f6482fe1 100644 --- a/workflow/readmes/vncserver/matlab_k8s.md +++ b/workflow/readmes/vncserver/matlab_k8s.md @@ -1,5 +1,5 @@ ## MATLAB Interactive Session -This workflow launches MATLAB in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS) or as a container on a **Kubernetes Cluster** using the official MATLAB docker [image](https://hub.docker.com/r/mathworks/matlab). +This workflow launches MATLAB in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS) or as a container on a **Kubernetes Cluster** using the official MATLAB docker [image](https://hub.docker.com/r/mathworks/matlab). Use the `Target Type` input to select your environment. diff --git a/workflow/readmes/vncserver/rstudio.md b/workflow/readmes/vncserver/rstudio.md index 959cc5e5c..15633510f 100644 --- a/workflow/readmes/vncserver/rstudio.md +++ b/workflow/readmes/vncserver/rstudio.md @@ -1,5 +1,5 @@ ## RStudio Interactive Session -This workflow launches RStudio in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). +This workflow launches RStudio in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/vncserver/rstudio_k8s.md b/workflow/readmes/vncserver/rstudio_k8s.md index 1c8c11e5d..d8741aee5 100644 --- a/workflow/readmes/vncserver/rstudio_k8s.md +++ b/workflow/readmes/vncserver/rstudio_k8s.md @@ -1,5 +1,5 @@ ## RStudio Interactive Session -This workflow launches RStudio in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS) or as a container on a **Kubernetes Cluster** using the official RStudio docker [image](https://hub.docker.com/r/rocker/rstudio). +This workflow launches RStudio in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS) or as a container on a **Kubernetes Cluster** using the official RStudio docker [image](https://hub.docker.com/r/rocker/rstudio). Use the `Target Type` input to select your environment. diff --git a/workflow/readmes/vncserver/schrodinger.md b/workflow/readmes/vncserver/schrodinger.md index c83dda855..b0120b7f3 100644 --- a/workflow/readmes/vncserver/schrodinger.md +++ b/workflow/readmes/vncserver/schrodinger.md @@ -1,5 +1,5 @@ ## Schrodinger Interactive Session -This workflow launches Schrodinger in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). +This workflow launches Schrodinger in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/vncserver/vmd.md b/workflow/readmes/vncserver/vmd.md index c88f8b874..7579376c1 100644 --- a/workflow/readmes/vncserver/vmd.md +++ b/workflow/readmes/vncserver/vmd.md @@ -1,5 +1,5 @@ ## VMD Interactive Session -This workflow launches VMD in a remote desktop [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). +This workflow launches VMD in a remote desktop [interactive session](../../../README.md) accessible via a web browser on a **Compute Cluster** (SLURM or PBS). It utilizes either TurboVNC, TigerVNC or KasmVNC, depending on which is installed on the target resource. diff --git a/workflow/readmes/webshell/noaa-onprem.md b/workflow/readmes/webshell/noaa-onprem.md index 4dc2c1c2e..8342fa346 100644 --- a/workflow/readmes/webshell/noaa-onprem.md +++ b/workflow/readmes/webshell/noaa-onprem.md @@ -1,3 +1,3 @@ ## Webshell Interactive Session -This workflow starts a Webshell server [interactive session](https://github.com/parallelworks/interactive_session/blob/main/README.md). +This workflow starts a Webshell server [interactive session](../../../README.md).