Skip to content

Hide binder links and references #3119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 3, 2023
Merged

Hide binder links and references #3119

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
218ba08
Fix release script and README
ptitzler Mar 1, 2023
add3cb3
Remove Binder references from readme and documentation
ptitzler Mar 2, 2023
1652eab
Address review comments
ptitzler Mar 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,6 @@ The [Elyra Getting Started Guide](https://elyra.readthedocs.io/en/latest/getting

## Try Elyra

#### Using Binder
You can try out some of Elyra features using the [My Binder](https://mybinder.readthedocs.io/en/latest/) service.

Click on a link below to try Elyra, on a sandbox environment, without having to install anything.

- [![Launch latest stable version](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/elyra-ai/elyra/v3.10.0?urlpath=lab/tree/binder-demo) (Latest stable version - see the [releases page](https://github.com/elyra-ai/elyra/releases) for a new features summary)
- [![Launch latest development version](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/elyra-ai/elyra/main?urlpath=lab/tree/binder-demo) (Development version - expect longer image load time due to just-in-time build)

#### Using container images

You can also try Elyra by running one of the container images from [Docker Hub](https://hub.docker.com/r/elyra/elyra/tags) or [quay.io](https://quay.io/repository/elyra/elyra?tab=tags):
Expand Down
12 changes: 6 additions & 6 deletions create-release.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,12 @@ def update_version_to_release() -> None:
# Update docker related tags
sed(_source("Makefile"), r"^TAG:=dev", f"TAG:={new_version}")
sed(_source("README.md"), r"elyra:dev ", f"elyra:{new_version} ")
if config.rc is None and config.beta is None:
# Update the stable version Binder link
sed(_source("README.md"), r"/v[0-9].[0-9].[0-9]?", f"/v{new_version}?")
# if config.rc is None and config.beta is None:
# Update the stable version Binder link
# sed(_source("README.md"), r"/v[0-9]\+\.[0-9]\+\.[0-9]\+", f"/v{new_version}?")
sed(_source("etc/docker/kubeflow/README.md"), r"kf-notebook:dev", f"kf-notebook:{new_version}")
sed(_source("docs/source/getting_started/installation.md"), r"elyra:dev ", f"elyra:{new_version} ")
sed(_source("docs/source/getting_started/installation.md"), r"/v[0-9].[0-9].[0-9]?", f"/v{new_version}?")
# sed(_source("docs/source/getting_started/installation.md"), r"/v[0-9].[0-9].[0-9]?", f"/v{new_version}?")
sed(_source("docs/source/recipes/configure-airflow-as-a-runtime.md"), r"main", f"{config.tag}")
sed(_source("docs/source/recipes/deploying-elyra-in-a-jupyterhub-environment.md"), r"dev", f"{new_version}")
sed(_source("docs/source/recipes/using-elyra-with-kubeflow-notebook-server.md"), r"main", f"{new_version}")
Expand Down Expand Up @@ -281,10 +281,10 @@ def update_version_to_dev() -> None:
sed(_source("README.md"), rf"elyra:{new_version} ", "elyra:dev ")
sed(_source("etc/docker/kubeflow/README.md"), rf"kf-notebook:{new_version}", "kf-notebook:dev")
# this does not goes back to dev
# sed(source('README.md'), rf"/v[0-9].[0-9].[0-9]", "/v{dev_version}")
# sed(source('README.md'), rf"/v[0-9]\+\.[0-9]\+\.[0-9]", "/v{dev_version}")
sed(_source("docs/source/getting_started/installation.md"), rf"elyra:{new_version} ", "elyra:dev ")
# this does not goes back to dev
# sed(source('docs/source/getting_started/installation.md'), rf"/v[0-9].[0-9].[0-9]", "/v{dev_version}")
# sed(source('docs/source/getting_started/installation.md'), rf"/v[0-9]\+\.[0-9]\+\.[0-9]", "/v{dev_version}")
sed(_source("docs/source/recipes/configure-airflow-as-a-runtime.md"), rf"{config.tag}", "main")
sed(_source("docs/source/recipes/deploying-elyra-in-a-jupyterhub-environment.md"), rf"{new_version}", "dev")
sed(_source("docs/source/recipes/using-elyra-with-kubeflow-notebook-server.md"), rf"{new_version}", "main")
Expand Down
10 changes: 5 additions & 5 deletions docs/source/getting_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,19 +226,19 @@ docker pull quay.io/elyra/elyra:dev

#### Running Elyra container images

Invocation example 1: Run Elyra v3.4.0 in a Docker container. All changes are discarded when the Docker container is stopped.
Invocation example 1: Run the latest stable Elyra release in a Docker container. All changes are discarded when the Docker container is stopped.

```
docker run -it -p 8888:8888 elyra/elyra:3.4.0 jupyter lab --debug
docker run -it -p 8888:8888 elyra/elyra:latest jupyter lab --debug
```

Invocation example 2: Run Elyra v3.4.0 in a Docker container and mount the existing local `$HOME/jupyter-notebooks/` directory as JupyterLab work directory. This enables you to make existing notebooks and other files available in the Docker container. Only files in this working directory are retained when the Docker container is stopped.
Invocation example 2: Run the latest stable Elyra release in a Docker container and mount the existing local `$HOME/jupyter-notebooks/` directory as JupyterLab work directory. This enables you to make existing notebooks and other files available in the Docker container. Only files in this working directory are retained when the Docker container is stopped.

```
docker run -it -p 8888:8888\
-v ${HOME}/jupyter-notebooks/:/home/jovyan/work\
-w /home/jovyan/work\
elyra/elyra:3.4.0 jupyter lab --debug
elyra/elyra:latest jupyter lab --debug
```

Invocation example 3: Same as above. In addition a local directory named `${HOME}/jupyter-data-dir` is mounted as the Jupyter data directory in the Docker container, storing all user-defined Elyra metadata artifacts you might create, such as code snippets, runtime configurations, or runtime images.
Expand All @@ -250,7 +250,7 @@ docker run -it -p 8888:8888\
-v ${HOME}/jupyter-notebooks/:/home/jovyan/work\
-w /home/jovyan/work\
-v ${HOME}/jupyter-data-dir:/home/jovyan/.local/share/jupyter\
elyra/elyra:3.4.0 jupyter lab --debug
elyra/elyra:latest jupyter lab --debug
```

Open the displayed URL in your browser to start using JupyterLab and Elyra.
Expand Down
2 changes: 0 additions & 2 deletions docs/source/getting_started/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ The main features include:
* [Language Server Protocol integration](#language-server-protocol-integration)
* [Version control using git integration](#version-control-using-git-integration)

You can try out some of these features using the getting started tour on [Binder](https://github.com/elyra-ai/elyra#using-binder) without having to install anything.

#### AI Pipelines visual editor

Building an AI pipeline for a model is hard, breaking down and modularizing a pipeline is harder.
Expand Down