From 404c2b75220806fe31e71bf971b3800906d8fcb2 Mon Sep 17 00:00:00 2001 From: annikakrilov <119340097+annikakrilov@users.noreply.github.com> Date: Tue, 9 Jul 2024 14:51:17 -0600 Subject: [PATCH] Update index.md --- docs/docs/index.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index 9a3fbd6..293a6f8 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -4,7 +4,7 @@ Please use [`rsconnect-python`](https://github.com/posit-dev/rsconnect-python) t # `rsconnect-jupyter` User Guide -The `rsconnect-jupyter` package is a _Jupyter Notebook_ extension (i.e., `nbextension`) that provides publishing compatibility with [Posit Connect](https://docs.posit.co/connect). +The `rsconnect-jupyter` package is a Jupyter Notebook extension (i.e., `nbextension`) that provides publishing compatibility with [Posit Connect](https://docs.posit.co/connect). ## Requirements @@ -14,18 +14,18 @@ The `rsconnect-jupyter` package is a _Jupyter Notebook_ extension (i.e., `nbexte - [Posit Connect](https://www.posit.co/download/posit-connect/) ([supported versions](https://posit.co/support/#supported-connect-versions)) !!! Warning - This extension is **NOT** compatible with _JupyterLab_. Only _Jupyter Notebooks_, and associated runtime environments, such as _JupyterHub_, are supported. + This extension is *not* compatible with JupyterLab. Only Jupyter Notebook, and associated runtime environments, such as JupyterHub, are supported. !!! Warning - In order to publish to _Posit Connect_, a compatible Python environment must in exist on the _Posit Connect_ instance. See the _Posit Connect_ documentation on [Python integrations](https://docs.posit.co/connect/admin/python/) for additional information. + In order to publish to Posit Connect, a compatible Python environment must in exist on the Connect instance. See the Connect documentation on [Python integrations](https://docs.posit.co/connect/admin/python/) for additional information. ## Installation --8<-- "snippets/install.md" -## Environment Configuration +## Environment configuration -### Localhost (Your Computer) +### Localhost (your computer) For localhost installation, a Python virtual environment is recommended to isolate runtime dependencies. There are various Python virtual environments available. The following tutorial covers a few of them. @@ -43,7 +43,7 @@ conda install -c conda-forge jupyter rsconnect-jupyter Next, following the [installation guide](#installation). !!! Tip - When creating a _Conda_ virtual environment, a specific Python version may be specified. Create your virtual environment with a Python environment that is available on your Posit Connect server. + When creating a Conda virtual environment, a specific Python version may be specified. Create your virtual environment with a Python environment that is available on your Posit Connect server.
Terminal
```shell @@ -52,9 +52,9 @@ Next, following the [installation guide](#installation). !!! Note - If _Anaconda_ is used, then _Jupyter Notebook_ launches with kernel environments for each existing Conda environment. Follow the [installation guide](#installation) for each kernel/Conda-environment to enable `rsconnect-jupyter`. + If Anaconda is used, then Jupyter Notebook launches with kernel environments for each existing Conda environment. Follow the [installation guide](#installation) for each kernel/Conda-environment to enable `rsconnect-jupyter`. -#### Python Virtual Environment ([venv](https://docs.python.org/3/library/venv.html)) +#### Python virtual environment ([venv](https://docs.python.org/3/library/venv.html))
Terminal
```shell @@ -69,20 +69,20 @@ Next, following the [installation guide](#installation). ### JupyterHub -Follow the [installation guide](#installation) to install and enable `rsconnect-jupyter` in _JupyterHub_. +Follow the [installation guide](#installation) to install and enable `rsconnect-jupyter` in JupyterHub. If you've configured separate kernel environments, repeat the installation guide for each kernel environment. !!! Note - The exact install location depends on your _JupyterHub_ configuration. + The exact install location depends on your JupyterHub configuration. -#### Quick Start Example +#### Quick start example -The following example shows how to launch a Docker container running _JupyterHub_ with the `rsconnect-jupyter` extension installed. +The following example shows how to launch a Docker container running JupyterHub with the `rsconnect-jupyter` extension installed. !!! Warning - This configuration is **NOT** intended for production usage. This is a minimal working configuration designed to highlight `rsconnect-jupyter` configuration. + This configuration is *not* intended for production usage. This is a minimal working configuration designed to highlight `rsconnect-jupyter` configuration. !!! Example "Docker Example" @@ -100,7 +100,7 @@ The following example shows how to launch a Docker container running _JupyterHub RUN python3 -m jupyter nbextension enable --sys-prefix --py rsconnect_jupyter RUN python3 -m jupyter serverextension enable --sys-prefix --py rsconnect_jupyter - # Create a new user called "username" with the password "password" + # Create a new user called "username" with the password "password". # # Use these credentials when logging into JupyterHub. # @@ -126,21 +126,21 @@ The following example shows how to launch a Docker container running _JupyterHub docker run --rm -p 8000:8000 --name jupyterhub jupyterhub:rsconnect-jupyter ``` - Once executed, a series of startup logs will be shown. Wait for the log message: `JupyterHub is now running at http://:8000`. + Once executed, a series of startup logs are shown. Wait for the log message: `JupyterHub is now running at http://:8000`. - Once shown, the _JupyterHub_ server is running on your local machine. To access _JupyterHub_ procceed with the following steps: + Once shown, the JupyterHub server is running on your local machine. To access JupyterHub, proceed with the following steps: 1. Open [http://localhost:8000](http://localhost:8000) in your browser. - 1. Login to using the credentials "username" and "password". These credentials match the credentials set in the Dockerfile and may be changed. - 1. Select the "New" dropdown menu and select "Python 3 (pykernal)". + 1. Login to using the credentials "username" and "password". These credentials match the credentials set in the Dockerfile and can be changed. + 1. Select the **New** dropdown menu and select **Python 3 (pykernal)**. 1. Next, follow the [usage guide](./usage). !!! Warning - At the time of writing, the `jupyterhub/jupyterhub:3` Docker image is built using Python version 3.10.6. Therefore, in order to publish to Posit Connect, a compatible Python version 3.10 environment must exist in Posit Connect. + At the time of writing, the `jupyterhub/jupyterhub:3` Docker image is built using Python version 3.10.6. Therefore, in order to publish to Posit Connect, a compatible Python version 3.10 environment must exist in Connect. ### Posit Workbench -[Posit Workbench](https://docs.posit.co/ide/server-pro/) supports _Jupyter Notebook_ sessions. See the [Jupyter Configuration](https://docs.posit.co/ide/server-pro/jupyter-sessions/configuration.html) guide to configure _Jupyter Notebook_ sessions. +[Posit Workbench](https://docs.posit.co/ide/server-pro/) supports Jupyter Notebook sessions. See the [Jupyter Configuration](https://docs.posit.co/ide/server-pro/jupyter_sessions/configuration.html) guide to configure Jupyter Notebook sessions. Once enabled, follow the [installation guide](#installation) to install and enable the `rsconnect-jupyter` plugin for each Jupyter kernel.