Skip to content
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.

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

Update user guide to enable elyra[all] install on zsh #2839

Merged
merged 2 commits into from
Aug 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/source/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Prior to version 3.1, the `elyra` package included all dependencies. Subsequent
If you use `pip`, install Elyra with:

```bash
pip3 install --upgrade elyra[all]
pip3 install --upgrade "elyra[all]"
```

If desired, you can install these Elyra extensions independently:
Expand Down Expand Up @@ -86,7 +86,7 @@ If desired, you can install these Elyra extensions independently:
If you use `conda`, install Elyra with:

```bash
conda install -c conda-forge elyra[all]
conda install -c conda-forge "elyra[all]"
```

**NOTE:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ OS user has that symbol in its name (e.g. `user@domain.com`)

This happens when trying to install Elyra via the Z Shell. The Z shell is the default shell on macOS versions of Catalina or later. Ensure that the argument is surrounded by single quotes as follows - this is not necessary when running on bash.
```
pip install --upgrade 'elyra[all]'
pip install --upgrade "elyra[all]"
```
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Elyra is a set of AI-centric extensions to JupyterLab Notebooks.
getting_started/tutorials.md
getting_started/getting-help.md
getting_started/changelog.md
getting_started/troubleshooting.md

.. toctree::
:maxdepth: 1
Expand Down Expand Up @@ -77,5 +78,4 @@ Elyra is a set of AI-centric extensions to JupyterLab Notebooks.
developer_guide/pipelines.md
developer_guide/pipeline-component-connectors.md
developer_guide/trackers.md
developer_guide/troubleshooting.md
developer_guide/release.md
2 changes: 1 addition & 1 deletion docs/source/user_guide/pipeline-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ To help you get started with custom components, the Elyra community has selected

Whether or not your Elyra includes the example components depends on how you deployed it:
- The community maintained [pre-built container images](getting_started.html#docker) have the example component catalogs for Kubeflow Pipelines pre-installed and enabled. The components are ready to use in the pipeline editor.
- All-inclusive stand-alone installations (e.g. `pip install elyra[all]`) include the example components. However, the catalog must be explicitly added to the palette.
- All-inclusive stand-alone installations (e.g. `pip install "elyra[all]"`) include the example components. However, the catalog must be explicitly added to the palette.
- Core-only installations (e.g. `pip install elyra`) do not include the example components. The example catalog must be separately installed and explicitly added to the palette.

**Installing and enabling the component examples catalogs**
Expand Down