Skip to content

Commit 9827332

Browse files
kylecarbskylecarbs
authored
chore: upgrade the manifest format moving metadata (#1209)
1 parent a831330 commit 9827332

File tree

245 files changed

+1276
-1531
lines changed

Some content is hidden

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

245 files changed

+1276
-1531
lines changed

‎.markdownlint.jsonc

+24-22
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,62 @@
22
// Default state for all rules is true
33
"default": true,
44

5+
"MD001": false,
6+
57
// Enforces headings use leftward hashtags
68
"MD003": "atx",
79

810
// Enforces consistent delimiter used for list items
911
"MD004": {
10-
"style": "dash"
12+
"style": "dash"
1113
},
1214

1315
"MD013": {
14-
"code_blocks": false,
15-
"tables": false
16+
"code_blocks": false,
17+
"tables": false
1618
},
1719

1820
// Enforces that the only punctuation that may appear at the end of a heading
1921
// is a question mark (?)
2022
"MD026": {
21-
"punctuation": ".,;:!"
23+
"punctuation": ".,;:!"
2224
},
23-
25+
2426
"MD029": {
25-
"style": "one"
27+
"style": "one"
2628
},
2729

2830
// Disables enforcement of HTML usage
2931
"MD033": false,
30-
32+
3133
// Enforces horizontal rules must be indicated with "---"
3234
"MD035": "---",
3335

3436
// Enforces that after Jekyll front-matter, an h2 is used
3537
"MD041": {
36-
"level": 2
38+
"level": 1
3739
},
3840

3941
// Enforces correct spelling and capitalization of the names array
4042
"MD044": {
41-
"names": [
42-
"Bitbucket",
43-
"GitHub",
44-
"GitLab",
45-
"Google",
46-
"Kubernetes",
47-
"JavaScript",
48-
"JSON",
49-
"PostgreSQL",
50-
"URL",
51-
"URLs"
52-
],
53-
"code_blocks": false
43+
"names": [
44+
"Bitbucket",
45+
"GitHub",
46+
"GitLab",
47+
"Google",
48+
"Kubernetes",
49+
"JavaScript",
50+
"JSON",
51+
"PostgreSQL",
52+
"URL",
53+
"URLs"
54+
],
55+
"code_blocks": false
5456
},
5557

5658
// Enforces all code blocks appear within code fences
5759
"MD046": "fenced",
58-
60+
5961
// Enforces backticks are used to create code fences
6062
"MD048": "backtick"
6163
}

‎about.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "About"
3-
description: "Learn about Coder, our mission, and why to choose us."
4-
---
1+
# About
52

63
Coder is a self-hosted platform that allows organizations to securely provision
74
developer workspaces for DevOps, infrastructure, and software engineering teams.

‎admin/access-control/manage.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Authentication management
3-
description: Learn how to manage Coder authentication.
4-
---
1+
# Authentication management
52

63
By default, Coder enables **built-in authentication**, though you can change
74
this if desired.

‎admin/access-control/organizations.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Organization roles
3-
description: Learn how to manage organization roles.
4-
---
1+
# Organization roles
52

63
You can assign members of an [organization](../organizations.md) roles, which
74
function like [user roles](users/user-roles.md). There are five roles available:

‎admin/access-control/users/password-reset.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Password reset
3-
description: Learn how to reset Coder user passwords.
4-
---
1+
# Password reset
52

63
This article walks you through resetting a user password, as well as resetting a
74
site admin's password.

‎admin/access-control/users/user-roles.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: User roles
3-
description: Learn about Coder's user roles and the privileges they offer.
4-
---
1+
# User roles
52

63
Coder allows you to assign different roles to users, and each role comes with a
74
distinct set of privileges regarding what the user can access and which actions

‎admin/access-url.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Access URL
3-
description: Learn how to set the access URL.
4-
---
1+
# Access URL
52

63
This article will show you how to change your **access URL**, which is a custom
74
domain name that you can use to access your Coder deployment.

‎admin/account-dormancy.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Account dormancy
3-
description: Learn how to manage the lifecycle of dormant user accounts.
4-
---
1+
# Account dormancy
52

63
Coder's account dormancy feature allows you to free up license seats if you have
74
users that aren't active on the platform for 90 days or more.

‎admin/appearance.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Appearance"
3-
description: Learn how to augment the dashboard appearance.
4-
---
1+
# Appearance
52

63
Coder offers you appearance customization options for the following:
74

‎admin/audit.md

+51-54
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Audit"
3-
description: Learn how Coder audits user and admin actions.
4-
---
1+
# Audit
52

63
Coder maintains records of all user actions on system resources for auditing
74
purposes.
@@ -61,74 +58,74 @@ actions included:
6158

6259
## Admin logged events
6360

64-
With the exception of a few, logged events made by Admin panel changes will output
65-
the changed field(s) and the new, corresponding value. Below is the expected
66-
(example) output for each Admin panel change.
61+
With the exception of a few, logged events made by Admin panel changes will
62+
output the changed field(s) and the new, corresponding value. Below is the
63+
expected (example) output for each Admin panel change.
6764

6865
> The Admin fields not documented below currently do not output a field/diff.
6966
7067
### Infrastructure
7168

72-
**Admin Setting** | **Action** | **Target** | **Field** | **Diff**
73-
------|------|------|------|------
74-
Access URL | Write | infrastructure | access URL | `coder.com`
75-
GPU Vendor | Write | infrastructure | gpu vendor | `amd/nvidia/none`
76-
Enable container-based virtual machines | Write | infrastructure | enable container vms| `true/false`
77-
Enable caching | Write | infrastructure | enabled cached container vms | `true/false`
78-
Enable auto loading of `shiftfs` kernel module | Write | infrastructure | enable load shiftfs | `true/false`
79-
Default to container-based virtual machines | Write | infrastructure | default container vms | `true/false`
80-
Enable self-contained workspace builds | Write | features | coder agent pull assets | `enabled/disabled`
81-
Enable workspace process logging | Write | features | exectrace | `enabled/disabled`
82-
Enable TUN device | Write | features | fuse device | `enabled/disabled`
83-
Enable FUSE device | Write | features | tun device | `enabled/disabled`
84-
Enable default registry | Write | infrastructure | default registry enabled | `true/false`
85-
Enable ECR IAM role authentication | Write |features | ecr auth irsa | `enabled/disabled`
86-
Enable AAD authentication for ACR | Write | features | azure auth aad | `enabled/disabled`
87-
Enable fallback shell support for K8s | Write | features | |
88-
Extension marketplace type | Write | * | ext marketplace type | `public/custom`
89-
Dev URL access permissions | Write | devurl access | public/org/authed/ | `true/false`
90-
Enable memory overprovisioning | Write | infrastructure | memory overprovisioning enabled | `true/false`
69+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
70+
| ---------------------------------------------- | ---------- | -------------- | ------------------------------- | ------------------ |
71+
| Access URL | Write | infrastructure | access URL | `coder.com` |
72+
| GPU Vendor | Write | infrastructure | gpu vendor | `amd/nvidia/none` |
73+
| Enable container-based virtual machines | Write | infrastructure | enable container vms | `true/false` |
74+
| Enable caching | Write | infrastructure | enabled cached container vms | `true/false` |
75+
| Enable auto loading of `shiftfs` kernel module | Write | infrastructure | enable load shiftfs | `true/false` |
76+
| Default to container-based virtual machines | Write | infrastructure | default container vms | `true/false` |
77+
| Enable self-contained workspace builds | Write | features | coder agent pull assets | `enabled/disabled` |
78+
| Enable workspace process logging | Write | features | exectrace | `enabled/disabled` |
79+
| Enable TUN device | Write | features | fuse device | `enabled/disabled` |
80+
| Enable FUSE device | Write | features | tun device | `enabled/disabled` |
81+
| Enable default registry | Write | infrastructure | default registry enabled | `true/false` |
82+
| Enable ECR IAM role authentication | Write | features | ecr auth irsa | `enabled/disabled` |
83+
| Enable AAD authentication for ACR | Write | features | azure auth aad | `enabled/disabled` |
84+
| Enable fallback shell support for K8s | Write | features | |
85+
| Extension marketplace type | Write | \* | ext marketplace type | `public/custom` |
86+
| Dev URL access permissions | Write | devurl access | public/org/authed/ | `true/false` |
87+
| Enable memory overprovisioning | Write | infrastructure | memory overprovisioning enabled | `true/false` |
9188

9289
### Git OAuth
9390

94-
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
95-
|------|------|------|------|------|
96-
| Client ID | Write | oauth configs | client id| `0fb2...7a4a` |
97-
| Client Secret | Write | oauth configs | client secret | `******` |
98-
| Description | Write | oauth configs | description | `example` |
99-
|Name | Write | oauth configs | name | `GitHub` |
100-
| Provider |Write | oauth configs |service type | `github/gitlab` |
101-
| URL | Write| oauth configs | URL host | `host.com`
91+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
92+
| ----------------- | ---------- | ------------- | ------------- | --------------- |
93+
| Client ID | Write | oauth configs | client id | `0fb2...7a4a` |
94+
| Client Secret | Write | oauth configs | client secret | `******` |
95+
| Description | Write | oauth configs | description | `example` |
96+
| Name | Write | oauth configs | name | `GitHub` |
97+
| Provider | Write | oauth configs | service type | `github/gitlab` |
98+
| URL | Write | oauth configs | URL host | `host.com` |
10299

103100
### Appearance
104101

105-
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
106-
|------|------|------|------|------|
107-
| System Banner | Write | system banner | enabled | `true/false` |
108-
| Background color | Write | system banner | color bg | `#9A4967` |
109-
| Footer | Write | system banner | text footer | `UNCLASSIFIED` |
110-
| Header | Write | system banner | text header | `UNCLASSIFIED` |
111-
| Service Banner | Write | appearance | svc banner enabled | `true/false` |
112-
| Background color | Write | appearance | svc banner color bg | `#18382D` |
113-
| Message | Write | appearance | svc banner body | `Maintenance 9:01PM` |
114-
| Terms of Service | Write | appearance | tos body | `Accept Terms & Conditions` |
115-
| Text field | Write | appearance | tos enabled | `true/false` |
102+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
103+
| ----------------- | ---------- | ------------- | ------------------- | --------------------------- |
104+
| System Banner | Write | system banner | enabled | `true/false` |
105+
| Background color | Write | system banner | color bg | `#9A4967` |
106+
| Footer | Write | system banner | text footer | `UNCLASSIFIED` |
107+
| Header | Write | system banner | text header | `UNCLASSIFIED` |
108+
| Service Banner | Write | appearance | svc banner enabled | `true/false` |
109+
| Background color | Write | appearance | svc banner color bg | `#18382D` |
110+
| Message | Write | appearance | svc banner body | `Maintenance 9:01PM` |
111+
| Terms of Service | Write | appearance | tos body | `Accept Terms & Conditions` |
112+
| Text field | Write | appearance | tos enabled | `true/false` |
116113

117114
### Telemetry
118115

119-
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
120-
|------|------|------|------|------|
121-
| Send crash reports | Write | telemetry | crash reports enabled | `true/false` |
122-
| Send usage telemetry | Write | telemetry | enhanced telemetry enabled| `true/false` |
123-
| Send enhanced usage telemetry | Write | telemetry | telemetry enabled | `true/false` |
116+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
117+
| ----------------------------- | ---------- | ---------- | -------------------------- | ------------ |
118+
| Send crash reports | Write | telemetry | crash reports enabled | `true/false` |
119+
| Send usage telemetry | Write | telemetry | enhanced telemetry enabled | `true/false` |
120+
| Send enhanced usage telemetry | Write | telemetry | telemetry enabled | `true/false` |
124121

125122
### Templates
126123

127124
> The template policy dropdown will provide a unique `commit`/`hash` for the
128125
> uploaded file. If file is uploaded from disk, then `file path`/`git ref` will
129126
> be `local`.
130127
131-
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
132-
|------|------|------|------|------|
133-
| Enable workspace templates | Write | infrastructure | enable workspaces as code | `true/false` |
134-
| Template policy | Write | local | commit/file hash/filepath/git ref/From | `0000...0000`/`ed19...843b`/`local`/`local`/`User`|
128+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
129+
| -------------------------- | ---------- | -------------- | -------------------------------------- | -------------------------------------------------- |
130+
| Enable workspace templates | Write | infrastructure | enable workspaces as code | `true/false` |
131+
| Template policy | Write | local | commit/file hash/filepath/git ref/From | `0000...0000`/`ed19...843b`/`local`/`local`/`User` |

‎admin/devurls.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Dev URLs"
3-
description: Learn how to configure dev URL support for a Coder deployment.
4-
---
1+
# Dev URLs
52

63
Developer (dev) URLs allow users to access the ports of running applications
74
they develop within their workspace. Coder listens for the applications running

‎admin/git.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
---
2-
title: Git integration
3-
description:
4-
Learn how to integrate with a Git provider to authenticate workspaces.
5-
---
1+
# Git integration
62

73
The Git Integration allows your developers to connect their Coder accounts to
84
their accounts with the Git repository service of choice.

‎admin/licensing.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Licensing"
3-
description: Learn how to manage the license for your Coder deployment.
4-
---
1+
# Licensing
52

63
You can manage your Coder licenses using the Dashboard when logged in as a site
74
manager.

‎admin/metrics.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Usage metrics
3-
description: Learn how to track usage of your Coder deployment.
4-
---
1+
# Usage metrics
52

63
Metrics allow you to track the number of people using Coder on a day-to-day
74
basis. Access the following view from **Manage > Metrics**.

‎admin/organizations/manage.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Org management
3-
description: Learn about managing organizations.
4-
---
1+
# Org management
52

63
This article shows how you can create, view, edit, or delete an organization.
74

‎admin/prometheus.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: Prometheus integration
3-
description: Learn how to configure Prometheus with Coder.
4-
---
1+
# Prometheus integration
52

63
The Prometheus integration enables you to query and visualize Coder's platform
74
metrics.

‎admin/registries/azure.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Azure Container Registry"
3-
description: Add a Microsoft Azure Container Registry (ACR) to Coder.
4-
---
1+
# Azure Container Registry
52

63
This article will show you how to add a private Azure Container Registry (ACR)
74
instance to Coder.

‎admin/registries/default-registry.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Default registry"
3-
description: Learn how to work with Coder's default registry.
4-
---
1+
# Default registry
52

63
> This feature is unavailable for air-gapped deployments.
74

‎admin/registries/ecr.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Amazon Elastic Container Registry"
3-
description: Add a private Amazon ECR to Coder.
4-
---
1+
# Amazon Elastic Container Registry
52

63
This article will show you how to add your private ECR to Coder. If you're using
74
a public ECR registry, you do not need to follow the steps below.

‎admin/registries/gcr.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
---
2-
title: "Google Container Registry"
3-
description: Add the Google Container Registry to Coder.
4-
---
1+
# Google Container Registry
52

63
Google Container Registry (GCR) uses different authorization methods, unlike the
74
generic `registry:2` image that requires a username and password. This article

‎admin/satellites/global-access-url.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
---
2-
title: Global access URL configuration
3-
description: |
4-
Learn how to configure your primary and satellite deployments so that they
5-
share an access URL.
6-
state: alpha
7-
---
1+
# Global access URL configuration
82

93
By default, the primary deployment and satellite deployments have different
104
access URLs. Using two access URLs can confuse engineering teams when it comes

0 commit comments

Comments
 (0)