diff --git a/docs/source/getting_started/installation.md b/docs/source/getting_started/installation.md index ccd60a95e..7608044f0 100644 --- a/docs/source/getting_started/installation.md +++ b/docs/source/getting_started/installation.md @@ -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: @@ -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:** diff --git a/docs/source/developer_guide/troubleshooting.md b/docs/source/getting_started/troubleshooting.md similarity index 97% rename from docs/source/developer_guide/troubleshooting.md rename to docs/source/getting_started/troubleshooting.md index dfdf6d45e..801d4f6ff 100644 --- a/docs/source/developer_guide/troubleshooting.md +++ b/docs/source/getting_started/troubleshooting.md @@ -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]" ``` diff --git a/docs/source/index.rst b/docs/source/index.rst index 4cbccc676..04c441920 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 @@ -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 diff --git a/docs/source/user_guide/pipeline-components.md b/docs/source/user_guide/pipeline-components.md index 25048ad0b..8299172cc 100644 --- a/docs/source/user_guide/pipeline-components.md +++ b/docs/source/user_guide/pipeline-components.md @@ -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**