You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 13, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: docs/docs/index.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Please use [`rsconnect-python`](https://github.com/posit-dev/rsconnect-python) t
4
4
5
5
# `rsconnect-jupyter` User Guide
6
6
7
-
The `rsconnect-jupyter` package is a _Jupyter Notebook_ extension (i.e., `nbextension`) that provides publishing compatibility with [Posit Connect](https://docs.posit.co/connect).
7
+
The `rsconnect-jupyter` package is a Jupyter Notebook extension (i.e., `nbextension`) that provides publishing compatibility with [Posit Connect](https://docs.posit.co/connect).
8
8
9
9
## Requirements
10
10
@@ -14,18 +14,18 @@ The `rsconnect-jupyter` package is a _Jupyter Notebook_ extension (i.e., `nbexte
This extension is **NOT** compatible with _JupyterLab_. Only _Jupyter Notebooks_, and associated runtime environments, such as _JupyterHub_, are supported.
17
+
This extension is *not* compatible with JupyterLab. Only Jupyter Notebook, and associated runtime environments, such as JupyterHub, are supported.
18
18
19
19
!!! Warning
20
-
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.
20
+
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.
21
21
22
22
## Installation
23
23
24
24
--8<-- "snippets/install.md"
25
25
26
-
## Environment Configuration
26
+
## Environment configuration
27
27
28
-
### Localhost (Your Computer)
28
+
### Localhost (your computer)
29
29
30
30
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.
Next, following the [installation guide](#installation).
44
44
45
45
!!! Tip
46
-
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.
46
+
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.
47
47
48
48
<div class="code-title">Terminal</div>
49
49
```shell
@@ -52,9 +52,9 @@ Next, following the [installation guide](#installation).
52
52
53
53
!!! Note
54
54
55
-
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`.
55
+
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`.
@@ -69,20 +69,20 @@ Next, following the [installation guide](#installation).
69
69
70
70
### JupyterHub
71
71
72
-
Follow the [installation guide](#installation) to install and enable `rsconnect-jupyter` in _JupyterHub_.
72
+
Follow the [installation guide](#installation) to install and enable `rsconnect-jupyter` in JupyterHub.
73
73
74
74
If you've configured separate kernel environments, repeat the installation guide for each kernel environment.
75
75
76
76
!!! Note
77
-
The exact install location depends on your _JupyterHub_ configuration.
77
+
The exact install location depends on your JupyterHub configuration.
78
78
79
-
#### Quick Start Example
79
+
#### Quick start example
80
80
81
-
The following example shows how to launch a Docker container running _JupyterHub_ with the `rsconnect-jupyter` extension installed.
81
+
The following example shows how to launch a Docker container running JupyterHub with the `rsconnect-jupyter` extension installed.
82
82
83
83
!!! Warning
84
84
85
-
This configuration is **NOT** intended for production usage. This is a minimal working configuration designed to highlight `rsconnect-jupyter` configuration.
85
+
This configuration is *not* intended for production usage. This is a minimal working configuration designed to highlight `rsconnect-jupyter` configuration.
86
86
87
87
!!! Example "Docker Example"
88
88
@@ -100,7 +100,7 @@ The following example shows how to launch a Docker container running _JupyterHub
100
100
RUN python3 -m jupyter nbextension enable --sys-prefix --py rsconnect_jupyter
101
101
RUN python3 -m jupyter serverextension enable --sys-prefix --py rsconnect_jupyter
102
102
103
-
# Create a new user called "username" with the password "password"
103
+
# Create a new user called "username" with the password "password".
104
104
#
105
105
# Use these credentials when logging into JupyterHub.
106
106
#
@@ -126,21 +126,21 @@ The following example shows how to launch a Docker container running _JupyterHub
126
126
docker run --rm -p 8000:8000 --name jupyterhub jupyterhub:rsconnect-jupyter
127
127
```
128
128
129
-
Once executed, a series of startup logs will be shown. Wait for the log message: `JupyterHub is now running at http://:8000`.
129
+
Once executed, a series of startup logs are shown. Wait for the log message: `JupyterHub is now running at http://:8000`.
130
130
131
-
Once shown, the _JupyterHub_ server is running on your local machine. To access _JupyterHub_ procceed with the following steps:
131
+
Once shown, the JupyterHub server is running on your local machine. To access JupyterHub, proceed with the following steps:
132
132
133
133
1. Open [http://localhost:8000](http://localhost:8000) in your browser.
134
-
1. Login to using the credentials "username" and "password". These credentials match the credentials set in the Dockerfile and may be changed.
135
-
1. Select the "New" dropdown menu and select "Python 3 (pykernal)".
134
+
1. Login to using the credentials "username" and "password". These credentials match the credentials set in the Dockerfile and can be changed.
135
+
1. Select the **New** dropdown menu and select **Python 3 (pykernal)**.
136
136
1. Next, follow the [usage guide](./usage).
137
137
138
138
!!! Warning
139
139
140
-
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.
140
+
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.
141
141
142
142
### Posit Workbench
143
143
144
-
[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.
144
+
[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.
145
145
146
146
Once enabled, follow the [installation guide](#installation) to install and enable the `rsconnect-jupyter` plugin for each Jupyter kernel.
0 commit comments