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

Skip to content

Commit 27e9826

Browse files
matifalimatifali
committed
Rename README.md to index.md for documentation files
Modernize the documentation structure by renaming all `README.md` files to `index.md`. This provides a more consistent and intuitive navigation, particularly for web-based documentation systems where `index.md` is commonly used as the default entry point.
1 parent 88790e2 commit 27e9826

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+689
-468
lines changed

‎docs/admin/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/admin/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Administration
2+
3+
These guides contain information on managing the Coder control plane and
4+
[authoring templates](./templates/index.md).
5+
6+
First time viewers looking to set up control plane access can start with the
7+
[configuration guide](./setup/index.md). If you're a team lead looking to design
8+
environments for your developers, check out our
9+
[templates guides](./templates/index.md). If you are a developer using Coder, we
10+
recommend the [user guides](../user-guides/index.md).
11+
12+
For automation and scripting workflows, see our [CLI](../reference/cli/index.md)
13+
and [API](../reference/api/index.md) docs.
14+
15+
For any information not strictly contained in these sections, check out our
16+
[Tutorials](../tutorials/index.md) and [FAQs](../tutorials/faqs.md).
17+
18+
<children></children>

‎docs/admin/infrastructure/README.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎docs/admin/infrastructure/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ It offers the following services along with much more:
7171
- `startup_script` automation
7272

7373
Templates are responsible for
74-
[creating and running agents](../templates/extending-templates/README.md#workspace-agents)
74+
[creating and running agents](../templates/extending-templates/index.md#workspace-agents)
7575
within workspaces.
7676

7777
## Service Bundling

‎docs/admin/infrastructure/index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Infrastructure
2+
3+
Learn how to spin up & manage Coder infrastructure.
4+
5+
## Architecture
6+
7+
Coder is a self-hosted platform that runs on your own servers. For large
8+
deployments, we recommend running the control plane on Kubernetes. Workspaces
9+
can be run as VMs or Kubernetes pods. The control plane (`coderd`) runs in a
10+
single region. However, workspace proxies, provisioners, and workspaces can run
11+
across regions or even cloud providers for the optimal developer experience.
12+
13+
Learn more about Coder's
14+
[architecture, concepts, and dependencies](./architecture.md).
15+
16+
## Reference Architectures
17+
18+
We publish [reference architectures](./validated-architectures/index.md) that
19+
include best practices around Coder configuration, infrastructure sizing,
20+
autoscaling, and operational readiness for different deployment sizes (e.g.
21+
`Up to 2000 users`).
22+
23+
## Scale Tests
24+
25+
Use our [scale test utility](./scale-utility.md) that can be run on your Coder
26+
deployment to simulate user activity and measure performance.
27+
28+
## Monitoring
29+
30+
See our dedicated [Monitoring](../monitoring/index.md) section for details
31+
around monitoring your Coder deployment via a bundled Grafana dashboard, health
32+
check, and/or within your own observability stack via Prometheus metrics.

‎docs/admin/infrastructure/scale-testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,12 @@ on the workload size to ensure deployment stability.
113113
#### CPU and memory usage
114114

115115
Enabling
116-
[agent stats collection](../../reference/cli/README.md#--prometheus-collect-agent-stats)
116+
[agent stats collection](../../reference/cli/index.md#--prometheus-collect-agent-stats)
117117
(optional) may increase memory consumption.
118118

119119
Enabling direct connections between users and workspace agents (apps or SSH
120120
traffic) can help prevent an increase in CPU usage. It is recommended to keep
121-
[this option enabled](../../reference/cli/README.md#--disable-direct-connections)
121+
[this option enabled](../../reference/cli/index.md#--disable-direct-connections)
122122
unless there are compelling reasons to disable it.
123123

124124
Inactive users do not consume Coder resources.

‎docs/admin/infrastructure/scale-utility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Learn more about [Coder’s architecture](./architecture.md) and our
1313

1414
> Note: the below information is for reference purposes only, and are not
1515
> intended to be used as guidelines for infrastructure sizing. Review the
16-
> [Reference Architectures](./validated-architectures/README.md#node-sizing) for
16+
> [Reference Architectures](./validated-architectures/index.md#node-sizing) for
1717
> hardware sizing recommendations.
1818
1919
| Environment | Coder CPU | Coder RAM | Coder Replicas | Database | Users | Concurrent builds | Concurrent connections (Terminal/SSH) | Coder Version | Last tested |

‎docs/admin/infrastructure/validated-architectures/README.md renamed to ‎docs/admin/infrastructure/validated-architectures/index.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,19 @@ by default.
6161

6262
### User
6363

64-
A [user](../../users/README.md) is an individual who utilizes the Coder platform to
65-
develop, test, and deploy applications using workspaces. Users can select
64+
A [user](../../users/index.md) is an individual who utilizes the Coder platform
65+
to develop, test, and deploy applications using workspaces. Users can select
6666
available templates to provision workspaces. They interact with Coder using the
6767
web interface, the CLI tool, or directly calling API methods.
6868

6969
### Workspace
7070

71-
A [workspace](../../../user-guides/workspace-creation.md) refers to an isolated development environment
72-
where users can write, build, and run code. Workspaces are fully configurable
73-
and can be tailored to specific project requirements, providing developers with
74-
a consistent and efficient development environment. Workspaces can be
75-
autostarted and autostopped, enabling efficient resource management.
71+
A [workspace](../../../user-guides/workspace-creation.md) refers to an isolated
72+
development environment where users can write, build, and run code. Workspaces
73+
are fully configurable and can be tailored to specific project requirements,
74+
providing developers with a consistent and efficient development environment.
75+
Workspaces can be autostarted and autostopped, enabling efficient resource
76+
management.
7677

7778
Users can connect to workspaces using SSH or via workspace applications like
7879
`code-server`, facilitating collaboration and remote access. Additionally,
@@ -82,22 +83,24 @@ Coder templates and deployed on resources created by provisioners.
8283

8384
### Template
8485

85-
A [template](../../../admin/templates/README.md) in Coder is a predefined configuration
86-
for creating workspaces. Templates streamline the process of workspace creation
87-
by providing pre-configured settings, tooling, and dependencies. They are built
88-
by template administrators on top of Terraform, allowing for efficient
89-
management of infrastructure resources. Additionally, templates can utilize
90-
Coder modules to leverage existing features shared with other templates,
91-
enhancing flexibility and consistency across deployments. Templates describe
92-
provisioning rules for infrastructure resources offered by Terraform providers.
86+
A [template](../../../admin/templates/index.md) in Coder is a predefined
87+
configuration for creating workspaces. Templates streamline the process of
88+
workspace creation by providing pre-configured settings, tooling, and
89+
dependencies. They are built by template administrators on top of Terraform,
90+
allowing for efficient management of infrastructure resources. Additionally,
91+
templates can utilize Coder modules to leverage existing features shared with
92+
other templates, enhancing flexibility and consistency across deployments.
93+
Templates describe provisioning rules for infrastructure resources offered by
94+
Terraform providers.
9395

9496
### Workspace Proxy
9597

96-
A [workspace proxy](../../../admin/networking/workspace-proxies.md) serves as a relay connection option
97-
for developers connecting to their workspace over SSH, a workspace app, or
98-
through port forwarding. It helps reduce network latency for geo-distributed
99-
teams by minimizing the distance network traffic needs to travel. Notably,
100-
workspace proxies do not handle dashboard connections or API calls.
98+
A [workspace proxy](../../../admin/networking/workspace-proxies.md) serves as a
99+
relay connection option for developers connecting to their workspace over SSH, a
100+
workspace app, or through port forwarding. It helps reduce network latency for
101+
geo-distributed teams by minimizing the distance network traffic needs to
102+
travel. Notably, workspace proxies do not handle dashboard connections or API
103+
calls.
101104

102105
### Provisioner
103106

@@ -297,8 +300,9 @@ considerations:
297300
active users.
298301
- Enable High Availability mode for database engine for large scale deployments.
299302

300-
If you enable [database encryption](../../../admin/security/database-encryption.md) in Coder, consider
301-
allocating an additional CPU core to every `coderd` replica.
303+
If you enable
304+
[database encryption](../../../admin/security/database-encryption.md) in Coder,
305+
consider allocating an additional CPU core to every `coderd` replica.
302306

303307
#### Resource utilization guidelines
304308

@@ -320,8 +324,8 @@ could affect workspace users experience once the platform is live.
320324

321325
### Helm Chart Configuration
322326

323-
1. Reference our [Helm chart values file](../../../../helm/coder/values.yaml) and
324-
identify the required values for deployment.
327+
1. Reference our [Helm chart values file](../../../../helm/coder/values.yaml)
328+
and identify the required values for deployment.
325329
1. Create a `values.yaml` and add it to your version control system.
326330
1. Determine the necessary environment variables. Here is the
327331
[full list of supported server environment variables](../../../reference/cli/server.md).
@@ -336,11 +340,10 @@ could affect workspace users experience once the platform is live.
336340
[version control](../../templates/managing-templates/change-management.md).
337341
1. Consider implementing a GitOps workflow to automatically push new template
338342
versions into Coder from git. For example, on Github, you can use the
339-
[Setup Coder](https://github.com/marketplace/actions/setup-coder)
340-
action.
343+
[Setup Coder](https://github.com/marketplace/actions/setup-coder) action.
341344
1. Evaluate enabling
342-
[automatic template updates](../../workspaces/README.md#update-policies)
343-
upon workspace startup.
345+
[automatic template updates](../../workspaces/index.md#update-policies) upon
346+
workspace startup.
344347

345348
### Observability
346349

@@ -351,13 +354,13 @@ could affect workspace users experience once the platform is live.
351354
leverage pre-configured dashboards, alerts, and runbooks for monitoring
352355
Coder. This includes integrations between Prometheus, Grafana, Loki, and
353356
Alertmanager.
354-
1. Review the [Prometheus response](../../integrations/prometheus.md) and set up alarms on
355-
selected metrics.
357+
1. Review the [Prometheus response](../../integrations/prometheus.md) and set up
358+
alarms on selected metrics.
356359

357360
### User support
358361

359-
1. Incorporate [support links](../../setup/appearance.md#support-links) into internal
360-
documentation accessible from the user context menu. Ensure that hyperlinks
361-
are valid and lead to up-to-date materials.
362+
1. Incorporate [support links](../../setup/appearance.md#support-links) into
363+
internal documentation accessible from the user context menu. Ensure that
364+
hyperlinks are valid and lead to up-to-date materials.
362365
1. Encourage the use of `coder support bundle` to allow workspace users to
363366
generate and provide network-related diagnostic data.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ docs. The control plane can be provisioned on any VM or container compute, and
55
workspaces can include any Terraform resource. See our
66
[architecture diagram](../infrastructure/architecture.md) for more details.
77

8-
You can host your deployment on almost any infrastructure. To learn how, read our [installation guides](../../install/README.md).
8+
You can host your deployment on almost any infrastructure. To learn how, read
9+
our [installation guides](../../install/index.md).
910

1011
<children></children>
1112

@@ -14,4 +15,4 @@ The following resources may help as you're deploying Coder.
1415
- [Coder packages: one-click install on cloud providers](https://github.com/coder/packages)
1516
- [Deploy Coder offline](../../install/offline.md)
1617
- [Supported resources (Terraform registry)](https://registry.terraform.io)
17-
- [Writing custom templates](../templates/README.md)
18+
- [Writing custom templates](../templates/index.md)

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

File renamed without changes.

‎docs/admin/monitoring/health-check.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The deployment health page is broken up into the following sections:
1313
## Access URL
1414

1515
The Access URL section shows checks related to Coder's
16-
[access URL](../setup/README.md#access-url).
16+
[access URL](../setup/index.md#access-url).
1717

1818
Coder will periodically send a GET request to `${CODER_ACCESS_URL}/healthz` and
1919
validate that the response is `200 OK`. The expected response body is also the
@@ -27,8 +27,7 @@ _Access URL not set_
2727

2828
**Problem:** no access URL has been configured.
2929

30-
**Solution:** configure an [access URL](../setup/README.md#access-url) for
31-
Coder.
30+
**Solution:** configure an [access URL](../setup/index.md#access-url) for Coder.
3231

3332
### EACS02
3433

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

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
# Monitoring Coder
22

3-
Learn about our the tools, techniques, and best practices to monitor Coder your Coder deployment.
3+
Learn about our the tools, techniques, and best practices to monitor Coder your
4+
Coder deployment.
45

56
## Quick Start: Observability Helm Chart
67

7-
Deploy Prometheus, Grafana, Alert Manager, and pre-built dashboards on your Kubernetes cluster to monitor the Coder control plane, provisioners, and workspaces.
8+
Deploy Prometheus, Grafana, Alert Manager, and pre-built dashboards on your
9+
Kubernetes cluster to monitor the Coder control plane, provisioners, and
10+
workspaces.
811

912
![Grafana Dashboard](../../images/admin/monitoring/grafana-dashboard.png)
1013

11-
Learn how to install & read the docs on the [Observability Helm Chart GitHub](https://github.com/coder/observability)
14+
Learn how to install & read the docs on the
15+
[Observability Helm Chart GitHub](https://github.com/coder/observability)
1216

1317
## Table of Contents
1418

15-
- [Logs](./logs.md): Learn how to access to Coder server logs, agent logs, and even how to expose Kubernetes pod scheduling logs.
16-
- [Metrics](./metrics.md): Learn about the valuable metrics to measure on a Coder deployment, regardless of your monitoring stack.
17-
- [Health Check](./health-check.md): Learn about the periodic health check and error codes that run on Coder deployments.
19+
- [Logs](./logs.md): Learn how to access to Coder server logs, agent logs, and
20+
even how to expose Kubernetes pod scheduling logs.
21+
- [Metrics](./metrics.md): Learn about the valuable metrics to measure on a
22+
Coder deployment, regardless of your monitoring stack.
23+
- [Health Check](./health-check.md): Learn about the periodic health check and
24+
error codes that run on Coder deployments.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ a workspace being deleted or a user being created.
55

66
## Enable experiment
77

8-
In order to activate the notifications feature on Coder v2.15.X, you'll need to enable the
9-
`notifications` experiment. Notifications are enabled by default starting in v2.16.0.
8+
In order to activate the notifications feature on Coder v2.15.X, you'll need to
9+
enable the `notifications` experiment. Notifications are enabled by default
10+
starting in v2.16.0.
1011

1112
```bash
1213
# Using the CLI flag

‎docs/admin/monitoring/notifications/slack.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Before setting up Slack notifications, ensure that you have the following:
1818

1919
- Administrator access to the Slack platform to create apps
2020
- Coder platform v2.15.0 or greater with
21-
[notifications enabled](./README.md#enable-experiment) for versions <v2.16.0
21+
[notifications enabled](./index.md#enable-experiment) for versions <v2.16.0
2222

2323
## Create Slack Application
2424

@@ -193,7 +193,7 @@ must respond appropriately.
193193
## Enable Webhook Integration in Coder
194194

195195
To enable webhook integration in Coder, ensure the "notifications"
196-
[experiment is activated](./README.md#enable-experiment) (only required in
196+
[experiment is activated](./index.md#enable-experiment) (only required in
197197
v2.15.X).
198198

199199
Then, define the POST webhook endpoint matching the deployed Slack bot:

‎docs/admin/monitoring/notifications/teams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Before setting up Microsoft Teams notifications, ensure that you have the
1515
following:
1616

1717
- Administrator access to the Teams platform
18-
- Coder platform with [notifications enabled](./README.md#enable-experiment)
18+
- Coder platform with [notifications enabled](./index.md#enable-experiment)
1919

2020
## Build Teams Workflow
2121

@@ -134,7 +134,7 @@ The process of setting up a Teams workflow consists of three key steps:
134134
## Enable Webhook Integration
135135

136136
To enable webhook integration in Coder, ensure the "notifications"
137-
[experiment is activated](./README.md#enable-experiment) (only required in
137+
[experiment is activated](./index.md#enable-experiment) (only required in
138138
v2.15.X).
139139

140140
Then, define the POST webhook endpoint created by your Teams workflow:

‎docs/admin/networking/high-availability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ connect to the same Postgres endpoint.
3232
HA brings one configuration variable to set in each Coderd node:
3333
`CODER_DERP_SERVER_RELAY_URL`. The HA nodes use these URLs to communicate with
3434
each other. Inter-node communication is only required while using the embedded
35-
relay (default). If you're using [custom relays](./README.md#custom-relays),
35+
relay (default). If you're using [custom relays](./index.md#custom-relays),
3636
Coder ignores `CODER_DERP_SERVER_RELAY_URL` since Postgres is the sole
3737
rendezvous for the Coder nodes.
3838

@@ -70,5 +70,5 @@ Then, increase the number of pods.
7070
7171
## Up next
7272
73-
- [Read more on Coder's networking stack](./README.md)
73+
- [Read more on Coder's networking stack](./index.md)
7474
- [Install on Kubernetes](../../install/kubernetes.md)

0 commit comments

Comments
 (0)