Skip to content

Commit 8cdbecf

Browse files
EdwardAngertEdwardAngert
committed
Merge remote-tracking branch 'origin/main' into 13207-preinstall-jetbrains
2 parents b5e8007 + 4495db8 commit 8cdbecf

File tree

299 files changed

+19979
-18025
lines changed

Some content is hidden

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

299 files changed

+19979
-18025
lines changed

‎.github/workflows/docs-ci.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Docs CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "docs/**"
9+
- "**.md"
10+
- ".github/workflows/docs-ci.yaml"
11+
12+
pull_request:
13+
paths:
14+
- "docs/**"
15+
- "**.md"
16+
- ".github/workflows/docs-ci.yaml"
17+
18+
jobs:
19+
docs:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
24+
25+
- name: Setup Node
26+
uses: ./.github/actions/setup-node
27+
28+
- uses: tj-actions/changed-files@bab30c2299617f6615ec02a68b9a40d10bd21366 # v45.0.5
29+
id: changed-files
30+
with:
31+
files: |
32+
docs/**
33+
**.md
34+
separator: ","
35+
36+
- name: lint
37+
if: steps.changed-files.outputs.any_changed == 'true'
38+
run: |
39+
pnpm exec markdownlint-cli2 ${{ steps.changed-files.outputs.all_changed_files }}
40+
41+
- name: fmt
42+
if: steps.changed-files.outputs.any_changed == 'true'
43+
run: |
44+
# markdown-table-formatter requires a space separated list of files
45+
echo ${{ steps.changed-files.outputs.all_changed_files }} | tr ',' '\n' | pnpm exec markdown-table-formatter --check

‎.markdownlint.jsonc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Example markdownlint configuration with all properties set to their default value
2+
{
3+
"MD010": { "spaces_per_tab": 4}, // No hard tabs: we use 4 spaces per tab
4+
5+
"MD013": false, // Line length: we are not following a strict line lnegth in markdown files
6+
7+
"MD024": { "siblings_only": true }, // Multiple headings with the same content:
8+
9+
"MD033": false, // Inline HTML: we use it in some places
10+
11+
"MD034": false, // Bare URL: we use it in some places in generated docs e.g.
12+
// codersdk/deployment.go L597, L1177, L2287, L2495, L2533
13+
// codersdk/workspaceproxy.go L196, L200-L201
14+
// coderd/tracing/exporter.go L26
15+
// cli/exp_scaletest.go L-9
16+
17+
"MD041": false, // First line in file should be a top level heading: All of our changelogs do not start with a top level heading
18+
// TODO: We need to update /home/coder/repos/coder/coder/scripts/release/generate_release_notes.sh to generate changelogs that follow this rule
19+
20+
"MD052": false, // Image reference: Not a valid reference in generated docs
21+
// docs/reference/cli/server.md L628
22+
23+
"MD055": false, // Table pipe style: Some of the generated tables do not have ending pipes
24+
// docs/reference/api/schema.md
25+
// docs/reference/api/templates.md
26+
// docs/reference/cli/server.md
27+
28+
"MD056": false // Table column count: Some of the auto-generated tables have issues. TODO: This is probably because of splitting cell content to multiple lines.
29+
// docs/reference/api/schema.md
30+
// docs/reference/api/templates.md
31+
}

‎.prettierignore

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

‎.prettierignore.include

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

‎.vscode/extensions.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
{
22
"recommendations": [
3+
"biomejs.biome",
4+
"bradlc.vscode-tailwindcss",
5+
"DavidAnson.vscode-markdownlint",
6+
"EditorConfig.EditorConfig",
7+
"emeraldwalk.runonsave",
8+
"foxundermoon.shell-format",
39
"github.vscode-codeql",
410
"golang.go",
511
"hashicorp.terraform",
6-
"esbenp.prettier-vscode",
7-
"foxundermoon.shell-format",
8-
"emeraldwalk.runonsave",
9-
"zxh404.vscode-proto3",
1012
"redhat.vscode-yaml",
1113
"tekumara.typos-vscode",
12-
"EditorConfig.EditorConfig",
13-
"biomejs.biome",
14-
"bradlc.vscode-tailwindcss"
14+
"zxh404.vscode-proto3"
1515
]
1616
}

‎CODE_OF_CONDUCT.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
[https://coder.com/docs/coder-oss/latest/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)
1+
<!-- markdownlint-disable MD041 -->
2+
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)

‎CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
https://coder.com/docs/CONTRIBUTING
1+
<!-- markdownlint-disable MD041 -->
2+
[https://coder.com/docs/CONTRIBUTING](https://coder.com/docs/CONTRIBUTING)

0 commit comments

Comments
 (0)