opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: adopt markdownlint and markdown-table-formatter for *.md (#15831)

Browse Source 
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
This commit is contained in:
Muhammad Atif Ali
2025-01-03 13:12:59 +00:00
committed by GitHub
co-authored by Edward Angert
parent 08463c27d8
commit 94f5d52fdc
255 changed files with 18279 additions and 16786 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/apidocgen/markdown-template/main.dot
+1 -1
View File
@@ -143,7 +143,7 @@
{{~}}
{{~}}
{{? (blocks[0].rows.length === 0) && (blocks.length === 1) }}
*None*
None
{{?}}
{{?}}
scripts/apidocgen/postprocess/main.go
+3 -1
View File
@@ -18,7 +18,9 @@ import (
const (
apiSubdir = "reference/api"
apiIndexFile = "index.md"
apiIndexContent = `Get started with the Coder API:
apiIndexContent = `# API
Get started with the Coder API:
## Quickstart
scripts/auditdocgen/main.go
+1 -1
View File
@@ -131,7 +131,7 @@ func updateAuditDoc(doc []byte, auditableResourcesMap AuditableResourcesMap) ([]
}
auditActionsString := strings.Join(auditActions, ", ")
_, _ = buffer.WriteString("|" + readableResourceName + "<br><i>" + auditActionsString + "</i>|<table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody>")
_, _ = buffer.WriteString("|" + readableResourceName + "<br><i>" + auditActionsString + "</i>|<table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody>" + "|")
// We must sort the field names to ensure sub-table ordering
sortedFieldNames := sortKeys(auditableResourcesMap[resourceName])
scripts/releasemigrations/README.md
+7 -7
View File
@@ -2,9 +2,9 @@
The `main.go` is a program that lists all releases and which migrations are contained with each upgrade.
# Usage
## Usage
```bash
```shell
releasemigrations [--patches] [--minors] [--majors]
-after-v2
Only include releases after v2.0.0
@@ -22,13 +22,13 @@ releasemigrations [--patches] [--minors] [--majors]
Comma separated list of versions to use. This skips uses git tag to find tags.
```
# Examples
## Examples
## Find all migrations between 2 versions
### Find all migrations between 2 versions
Going from 2.3.0 to 2.4.0
```bash
```shell
$ go run scripts/releasemigrations/main.go --list --versions=v2.3.0,v2.4.0 11:47:00 AM
2023/11/21 11:47:09 [minor] 4 migrations added between v2.3.0 and v2.4.0
2023/11/21 11:47:09 coderd/database/migrations/000165_prevent_autostart_days.up.sql
@@ -42,7 +42,7 @@ $ go run scripts/releasemigrations/main.go --list --versions=v2.3.0,v2.4.0
## Looking at all patch releases after v2
```bash
```shell
$ go run scripts/releasemigrations/main.go --patches --after-v2 11:47:09 AM
2023/11/21 11:48:00 [patch] No migrations added between v2.0.0 and v2.0.1
2023/11/21 11:48:00 [patch] 2 migrations added between v2.0.1 and v2.0.2
@@ -63,7 +63,7 @@ $ go run scripts/releasemigrations/main.go --patches --after-v2
This shows when every migration was introduced.
```bash
```shell
$ go run scripts/releasemigrations/main.go --patches --minors --majors --list
# ...
2023/11/21 11:48:31 [minor] 5 migrations added between v2.2.1 and v2.3.0