Skip to content

chore: docs fixes based on requests #984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 5, 2022
Merged

chore: docs fixes based on requests #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5aa4f3
chore: redo dev URL examples
May 4, 2022
63a2422
chore: fix inverted STUN/TURN definitions
May 4, 2022
2fdbe93
chore: add links to instructions for PWAs
May 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions workspaces/devurls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,17 @@ There are two ways for you to construct dev URLs.
If you provided a name for the dev URL when you created it:

```text
<name>--<username>.domain
devUrlName--username.domain

# ex: main--jessieLorem.exampleCo.com
```

If you didn't provide a name for the dev URL when you created it:

```text
<port>--<workspace_name>-<username>.domain
portNumber--workspaceName-username.domain

# ex: 8080--mainDev-jessieLorem.exampleCo.com
```

For example, let's say that you've created a dev URL for port `8080`. Also:
Expand Down
4 changes: 2 additions & 2 deletions workspaces/preferences.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ the Coder CLI:

- **Auto** (default): uses STUN and falls back to TURN if it's unable to
establish a peer-to-peer connection
- **TURN**: establishes a peer-to-peer connection
- **STUN**: establishes a connection using an intermediary relay server
- **TURN**: establishes a connection using an intermediary relay server
- **STUN**: establishes a peer-to-peer connection

## Auto-start

Expand Down
9 changes: 7 additions & 2 deletions workspaces/pwa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Progressive web apps"
description: Learn how to install the editor PWAs for a native IDE-like browser editing experience.
description:
Learn how to install the editor PWAs for a native IDE-like browser editing
experience.
---

In addition to running Coder in a web browser, you can also run each application
Expand All @@ -17,6 +19,9 @@ Google Chrome or Microsoft Edge.
1. Log into Coder and select your workspace.
1. Under **Applications**, click on an application to launch it as a new window
or tab.
1. Follow your browser's instructions for installing the application as a PWA.
1. Follow your browser's instructions for installing the application as a
[Google Chrome](https://support.google.com/chrome/answer/9658361) or a
[Microsoft Edge](https://docs.microsoft.com/en-us/microsoft-edge/progressive-web-apps-chromium/ux#installing-a-pwa)
PWA.

Please note that applications are currently installed on a per-workspace basis.