Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 35d506e

Browse files
bpmctbpmct
committed
chore: move docs pages into corresponding folder
1 parent 4b99e2d commit 35d506e

File tree

5 files changed

+18
-16
lines changed

5 files changed

+18
-16
lines changed

‎docs/admin/index.md renamed to ‎docs/admin/README.md

File renamed without changes.

‎docs/manifest.json

Lines changed: 6 additions & 4 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",
@@ -76,7 +78,7 @@
7678
{
7779
"title": "Platforms",
7880
"description": "Platform-specific guides using Coder",
79-
"path": "./platforms.md",
81+
"path": "./platforms/README.md",
8082
"icon_path": "./images/icons/star.svg",
8183
"children": [
8284
{
@@ -125,7 +127,7 @@
125127
{
126128
"title": "Templates",
127129
"description": "Learn about templates, which define the infrastructure underlying workspaces",
128-
"path": "./templates.md",
130+
"path": "./templates/README.md",
129131
"icon_path": "./images/icons/picture.svg",
130132
"children": [
131133
{
@@ -241,7 +243,7 @@
241243
{
242244
"title": "Administration",
243245
"description": "How to install and deploy Coder",
244-
"path": "./admin/index.md",
246+
"path": "./admin/README.md",
245247
"icon_path": "./images/icons/wrench.svg",
246248
"children": [
247249
{

‎docs/networking.md renamed to ‎docs/networking/README.md

File renamed without changes.

‎docs/platforms.md renamed to ‎docs/platforms/README.md

File renamed without changes.

‎docs/templates.md renamed to ‎docs/templates/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ kubernetes_pod).
66

77
In most cases, a small group of users (team leads or Coder administrators) [have
88
permissions](./admin/users.md#roles) to create and manage templates. Then, other
9-
users provision their [workspaces](./workspaces.md) from templates using the UI
9+
users provision their [workspaces](../workspaces.md) from templates using the UI
1010
or CLI.
1111

1212
## Get the CLI
@@ -149,7 +149,7 @@ for the full list of supported arguments for the `coder_agent`.
149149
#### startup_script
150150

151151
Use the Coder agent's `startup_script` to run additional commands like
152-
installing IDEs, [cloning dotfiles](./dotfiles.md#templates), and cloning
152+
installing IDEs, [cloning dotfiles](../dotfiles.md#templates), and cloning
153153
project repos.
154154

155155
```hcl
@@ -187,7 +187,7 @@ coder dotfiles -y ${var.dotfiles_uri}
187187

188188
### Start/stop
189189

190-
[Learn about resource persistence in Coder](./templates/resource-persistence.md)
190+
[Learn about resource persistence in Coder](./resource-persistence.md)
191191

192192
Coder workspaces can be started/stopped. This is often used to save on cloud
193193
costs or enforce ephemeral workflows. When a workspace is started or stopped,
@@ -246,7 +246,7 @@ resource "kubernetes_pod" "podName" {
246246
### Edit templates
247247

248248
You can edit a template using the coder CLI. Only [template admins and
249-
owners](./admin/users.md) can edit a template.
249+
owners](../admin/users.md) can edit a template.
250250

251251
Using the CLI, login to Coder and run the following command to edit a single
252252
template:
@@ -283,7 +283,7 @@ prompt in the dashboard to update.
283283
### Delete templates
284284

285285
You can delete a template using both the coder CLI and UI. Only [template admins
286-
and owners](./admin/users.md) can delete a template, and the template must not
286+
and owners](../admin/users.md) can delete a template, and the template must not
287287
have any running workspaces associated to it.
288288

289289
Using the CLI, login to Coder and run the following command to delete a
@@ -296,7 +296,7 @@ coder templates delete <template-name>
296296
In the UI, navigate to the template you want to delete, and select the dropdown
297297
in the right-hand corner of the page to delete the template.
298298

299-
![delete-template](./images/delete-template.png)
299+
![delete-template](../images/delete-template.png)
300300

301301
#### Delete workspaces
302302

@@ -313,7 +313,7 @@ associated with the workspace.
313313
### Coder apps
314314

315315
By default, all templates allow developers to connect over SSH and a web
316-
terminal. See [Configuring Web IDEs](./ides/web-ides.md) to learn how to give
316+
terminal. See [Configuring Web IDEs](../ides/web-ides.md) to learn how to give
317317
users access to additional web applications.
318318

319319
### Data source
@@ -362,7 +362,7 @@ practices:
362362

363363
- Ensure the resource has `curl` installed (alternatively, `wget` or `busybox`)
364364
- Ensure the resource can `curl` your Coder [access
365-
URL](./admin/configure.md#access-url)
365+
URL](../admin/configure.md#access-url)
366366
- Manually connect to the resource and check the agent logs (e.g., `kubectl exec`, `docker exec` or AWS console)
367367
- The Coder agent logs are typically stored in `/tmp/coder-agent.log`
368368
- The Coder agent startup script logs are typically stored in `/tmp/coder-startup-script.log`
@@ -412,7 +412,7 @@ You can see a list of community templates by our users
412412

413413
## Next Steps
414414

415-
- Learn about [Authentication & Secrets](templates/authentication.md)
416-
- Learn about [Change Management](templates/change-management.md)
417-
- Learn about [Resource Metadata](templates/resource-metadata.md)
418-
- Learn about [Workspaces](workspaces.md)
415+
- Learn about [Authentication & Secrets](./authentication.md)
416+
- Learn about [Change Management](./change-management.md)
417+
- Learn about [Resource Metadata](./resource-metadata.md)
418+
- Learn about [Workspaces](./workspaces.md)

0 commit comments

Comments
 (0)