Skip to content
This repository was archived by the owner on Nov 13, 2024. It is now read-only.

Commit 7dfabd6

Browse files
authored
Merge pull request #375 from rstudio/ak_jupyterconfig374
Doc: correct broken link and style guide updates
2 parents ee4c6ff + 404c2b7 commit 7dfabd6

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/docs/index.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Please use [`rsconnect-python`](https://github.com/posit-dev/rsconnect-python) t
44

55
# `rsconnect-jupyter` User Guide
66

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).
88

99
## Requirements
1010

@@ -14,18 +14,18 @@ The `rsconnect-jupyter` package is a _Jupyter Notebook_ extension (i.e., `nbexte
1414
- [Posit Connect](https://www.posit.co/download/posit-connect/) ([supported versions](https://posit.co/support/#supported-connect-versions))
1515

1616
!!! Warning
17-
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.
1818

1919
!!! 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.
2121

2222
## Installation
2323

2424
--8<-- "snippets/install.md"
2525

26-
## Environment Configuration
26+
## Environment configuration
2727

28-
### Localhost (Your Computer)
28+
### Localhost (your computer)
2929

3030
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.
3131

@@ -43,7 +43,7 @@ conda install -c conda-forge jupyter rsconnect-jupyter
4343
Next, following the [installation guide](#installation).
4444

4545
!!! 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.
4747

4848
<div class="code-title">Terminal</div>
4949
```shell
@@ -52,9 +52,9 @@ Next, following the [installation guide](#installation).
5252

5353
!!! Note
5454

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`.
5656

57-
#### Python Virtual Environment ([venv](https://docs.python.org/3/library/venv.html))
57+
#### Python virtual environment ([venv](https://docs.python.org/3/library/venv.html))
5858

5959
<div class="code-title">Terminal</div>
6060
```shell
@@ -69,20 +69,20 @@ Next, following the [installation guide](#installation).
6969

7070
### JupyterHub
7171

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.
7373

7474
If you've configured separate kernel environments, repeat the installation guide for each kernel environment.
7575

7676
!!! Note
77-
The exact install location depends on your _JupyterHub_ configuration.
77+
The exact install location depends on your JupyterHub configuration.
7878

79-
#### Quick Start Example
79+
#### Quick start example
8080

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.
8282

8383
!!! Warning
8484

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.
8686

8787
!!! Example "Docker Example"
8888

@@ -100,7 +100,7 @@ The following example shows how to launch a Docker container running _JupyterHub
100100
RUN python3 -m jupyter nbextension enable --sys-prefix --py rsconnect_jupyter
101101
RUN python3 -m jupyter serverextension enable --sys-prefix --py rsconnect_jupyter
102102

103-
# Create a new user called "username" with the password "password"
103+
# Create a new user called "username" with the password "password".
104104
#
105105
# Use these credentials when logging into JupyterHub.
106106
#
@@ -126,21 +126,21 @@ The following example shows how to launch a Docker container running _JupyterHub
126126
docker run --rm -p 8000:8000 --name jupyterhub jupyterhub:rsconnect-jupyter
127127
```
128128

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`.
130130

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:
132132

133133
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)**.
136136
1. Next, follow the [usage guide](./usage).
137137

138138
!!! Warning
139139

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.
141141

142142
### Posit Workbench
143143

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.
145145

146146
Once enabled, follow the [installation guide](#installation) to install and enable the `rsconnect-jupyter` plugin for each Jupyter kernel.

0 commit comments

Comments
 (0)