Skip to content

Commit 0c29255

Browse files
authored
chore: 2 minor clarifications around features (coder#1155)
* chore: 2 minor clarifications around features * lint
1 parent 23e65b6 commit 0c29255

File tree

3 files changed

+29
-17
lines changed

3 files changed

+29
-17
lines changed

admin/git.md

+14
Original file line numberDiff line numberDiff line change
@@ -125,3 +125,17 @@ When done, click **Save**.
125125
> - name: CODERD_BITBUCKET_CONSUMER_KEY
126126
> value: ""
127127
> ```
128+
129+
### Built-in GitHub Integration (VS Code)
130+
131+
Alternatively, users can VS Code's
132+
[built-in GitHub integration](https://code.visualstudio.com/docs/sourcecontrol/github)
133+
in order to clone repositories within VS Code Remote and code-server. This uses
134+
a GitHub token to authenticate instead of SSH keys.
135+
136+
To cache the token within the workspace, users can run the following command.
137+
This can also be added to a [configure script](../images/configure.md):
138+
139+
```sh
140+
git config --global credential.helper store
141+
```

setup/scaling.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,5 @@ ensuring sufficient resources and response time.
8484

8585
### Horizontal Pod Autoscaling
8686

87-
Horizontal Pod Autoscaling (HPA) is another Kubernetes technique to
88-
automatically add, and remove, additional `coderd` pods when the existing pods
89-
exceed sustained CPU and memory thresholds. Consult
90-
[Kubernetes HPA documentation](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
91-
for the various API version implementations of HPA.
87+
We do not recommend using [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
88+
with Coder. In some environments, this will lead to errors with workspace builds.

workspaces/editors.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ from your local VS Code, connected to your Coder workspace for compute, etc.
3737
> `remote.SSH.allowLocalServerDownload` enabled so the extension will install
3838
> the VS Code Server on the client first and then copy it over to the Coder
3939
> workspace via SCP.
40-
>
41-
> For further troubleshooting steps, see [Troubleshooting hanging or failing
42-
> connections](https://code.visualstudio.com/docs/remote/troubleshooting#_troubleshooting-hanging-or-failing-connections)
40+
>
41+
> For further troubleshooting steps, see
42+
> [Troubleshooting hanging or failing connections](https://code.visualstudio.com/docs/remote/troubleshooting#_troubleshooting-hanging-or-failing-connections)
4343
4444
![VS Code Remote Explorer](../assets/workspaces/vscode-remote-ssh-panel.png)
4545

@@ -328,8 +328,8 @@ for setting up your custom image and configure script.
328328

329329
Jupyter Notebook is the original web IDE for creating Notebooks used in data
330330
science, machine learning and analytics projects. By default, any Coder
331-
workspace with the Jupyter project installed (in `/usr/local/bin/jupyter`)
332-
will render the icon to launch Jupyter Notebook.
331+
workspace with the Jupyter project installed (in `/usr/local/bin/jupyter`) will
332+
render the icon to launch Jupyter Notebook.
333333

334334
![Jupyter Notework](../assets/workspaces/jupyter-notebook-icon.png)
335335

@@ -378,8 +378,9 @@ RUN chmod +x jupyter
378378
USER coder
379379
```
380380

381-
Below is an example `jupyter` script with the lab arguments. This file must
382-
be located in the same directory as the Dockerfile to be copied during `docker build`
381+
Below is an example `jupyter` script with the lab arguments. This file must be
382+
located in the same directory as the Dockerfile to be copied during
383+
`docker build`
383384

384385
```sh
385386
#!/bin/bash
@@ -391,10 +392,10 @@ args=${args/notebook/"lab"}
391392
jupyter.py ${args}
392393
```
393394

394-
The second method to run JupyterLab is with a dev URL and launching
395-
JupyterLab via `supervisord` in the `configure` script. The benefit of this
396-
approach is it is completely independent of Coder's IDE launching mechanism
397-
and relies only on a generic dev URL.
395+
The second method to run JupyterLab is with a dev URL and launching JupyterLab
396+
via `supervisord` in the `configure` script. The benefit of this approach is it
397+
is completely independent of Coder's IDE launching mechanism and relies only on
398+
a generic dev URL.
398399

399400
![JupyterLab as a dev URL](../assets/workspaces/jupyterlab-as-devurl.png)
400401

@@ -448,7 +449,7 @@ directory=/home/coder
448449
The third method to access JupyterLab is locally using the SSH port forward
449450
command: `ssh -L 8888:localhost:8888 coder.jupyterlab`. Alternatively, you can
450451
use the Coder CLI to port forward using: `coder tunnel jupyterlab 8888 8888`.
451-
Now, open a local browser and navigate to `https://localhost:8888`.
452+
Now, open a local browser and navigate to `https://localhost:8888`.
452453

453454
## RStudio
454455

0 commit comments

Comments
 (0)