Skip to content

Commit 5d35468

Browse files
matifalimatifali
committed
rebase on main 
1 parent bae1224 commit 5d35468

File tree

7 files changed

+60
-102
lines changed

7 files changed

+60
-102
lines changed

‎docs/manifest.old.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"versions": ["main"],
2+
"versions": [
3+
"main"
4+
],
35
"routes": [
46
{
57
"title": "About",
@@ -519,7 +521,7 @@
519521
]
520522
},
521523
{
522-
"title": "API",
524+
"title": "REST API",
523525
"description": "Learn how to use Coderd API",
524526
"path": "./api/index.md",
525527
"icon_path": "./images/icons/api.svg",

‎docs/reference/api/index.md

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/tutorials/operating/README.md

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +0,0 @@
1-
# Administration
2-
3-
A hub for all tutorials around day 2+ operations with Coder, including preparing for production and scaling to thousands of daily active users.
4-
5-
## Table of contents
6-
7-
- Prerequisites
8-
- Operational Readiness Checklist
9-
- Kubernetes vs VM Workspaces
10-
- Infrastructure
11-
- Kubernetes Best Practices
12-
- Reference Architectures (up to 3000 users)
13-
- VM Best Practices
14-
- Optimize networking & latency
15-
- Add workspace regions
16-
- Add Kubernetes clusters
17-
- Scale testing your Coder deployment
18-
- User Management
19-
- Set up OpenID Connect (SSO)
20-
- Configure Group & Role Sync
21-
- Configure Template Permissions
22-
- Workspace Management
23-
- Keep workspaces up to date
24-
- Clean up unused workspaces
25-
- Template & Image Management
26-
- Building golden images
27-
- Add Dev Container support (custom dependencies)
28-
- Manage templates with Ci/Cd pipelines
29-
- Security
30-
- Auditing Coder users
31-
- Managing cloud secrets
32-
- Manage workspace secrets
33-
- Security flags
34-
- Monitoring
35-
- Configure server logging
36-
- Troubleshooting Templates
37-
- Monitoring via Prometheus / Grafana
38-
- Analytics
39-
- Measure user adoption (weekly active users)
40-
- Identifying Coder power users
41-
- Reading template usage metrics

‎docs/user-guides/README.md

Lines changed: 4 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,7 @@
11
# Workspaces
22

3-
### What is a Workspace?
3+
TODO: write me
44

5-
At the highest level, a workspace is a set of cloud resources. These resources
6-
can be VMs, Kubernetes clusters, storage buckets, or whatever else [Terraform](https://developer.hashicorp.com/terraform/docs)
7-
lets you dream up.
8-
9-
Coder Workspaces are managed by the workspace agent, which facilitates [connections](./workspace-access.md).
10-
11-
## Viewing workspaces
12-
13-
You can manage your existing workspaces in the **Workspaces** tab. The name, associated template, and status are shown for each workspace. You can pin workspaces to the top of this UI by marking them as "favorite."
14-
15-
![Workspace listing UI](../images/user-guides/workspace-list-ui.png)
16-
17-
## Creating workspaces
18-
19-
You can create a workspace in the UI. Log in to your Coder instance, go to the
20-
**Templates** tab, find the template you need, and select **Create Workspace**.
21-
22-
![Creating a workspace in the UI](./images/user-guides/create-workspace-ui.png)
23-
24-
When you create a workspace, you will be prompted to give it a name. You might
25-
also be prompted to set some [parameters](#workspace-parameters) that the template provides.
26-
27-
You can also create a workspace from the command line:
28-
29-
Each Coder user has their own workspaces created from
30-
[shared templates](../admin/templates/README.md):
31-
32-
```shell
33-
# create a workspace from the template; specify any variables
34-
coder create --template="<templateName>" <workspaceName>
35-
36-
# show the resources behind the workspace and how to connect
37-
coder show <workspace-name>
38-
```
39-
40-
## Updating workspaces
41-
42-
After updating the default version of the template that a workspace was created
43-
from, you can update the workspace.
44-
45-
<!-- TODO: Update screenshot -->
46-
47-
![Updating a workspace](../images/workspace-update.png)
48-
49-
If the workspace is running, Coder stops it, updates it, then starts the
50-
workspace again.
51-
52-
On the command line:
53-
54-
```shell
55-
coder update <workspace-name>
56-
```
57-
58-
## Next steps
59-
60-
- [Access your workspace](./workspace-access/README.md)
61-
- [Learn about templates](./admin/templates/README.md)
62-
- [Try Coder](../start/coder-tour.md)
5+
- What is a workspace
6+
- Troubleshooting/logs
7+
- link children

‎docs/user-guides/workspace-access.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Access your workspace
2+
3+
TODO:
4+
5+
- through the UI
6+
- coder ssh
7+
- ports
8+
- listening/shared ports
9+
- port forwarding
10+
- coder apps
11+
- VSCode
12+
- Jetbrains

‎docs/user-guides/workspace-creation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Creating workspaces
2+
3+
TODO:
4+
5+
- write short guide on GUI, CLI
6+
- write explanation on parameters

‎docs/user-guides/workspace-maintenance.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Maintaining your workspaces
2+
3+
TODO:
4+
5+
- viewing/filtering
6+
- Mass operations
7+
- Scheduling

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy