forked from coder/coder
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
469 changed files
with
24,320 additions
and
19,817 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
enabled: true | ||
preservePullRequestTitle: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: Docs CI | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- "docs/**" | ||
- "**.md" | ||
- ".github/workflows/docs-ci.yaml" | ||
|
||
pull_request: | ||
paths: | ||
- "docs/**" | ||
- "**.md" | ||
- ".github/workflows/docs-ci.yaml" | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 | ||
|
||
- name: Setup Node | ||
uses: ./.github/actions/setup-node | ||
|
||
- uses: tj-actions/changed-files@bab30c2299617f6615ec02a68b9a40d10bd21366 # v45.0.5 | ||
id: changed-files | ||
with: | ||
files: | | ||
docs/** | ||
**.md | ||
separator: "," | ||
|
||
- name: lint | ||
if: steps.changed-files.outputs.any_changed == 'true' | ||
run: | | ||
pnpm exec markdownlint-cli2 ${{ steps.changed-files.outputs.all_changed_files }} | ||
- name: fmt | ||
if: steps.changed-files.outputs.any_changed == 'true' | ||
run: | | ||
# markdown-table-formatter requires a space separated list of files | ||
echo ${{ steps.changed-files.outputs.all_changed_files }} | tr ',' '\n' | pnpm exec markdown-table-formatter --check |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,6 +7,7 @@ on: | |
push: | ||
branches-ignore: | ||
- main | ||
- "temp-cherry-pick-*" | ||
workflow_dispatch: | ||
inputs: | ||
experiments: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
// Example markdownlint configuration with all properties set to their default value | ||
{ | ||
"MD010": { "spaces_per_tab": 4}, // No hard tabs: we use 4 spaces per tab | ||
|
||
"MD013": false, // Line length: we are not following a strict line lnegth in markdown files | ||
|
||
"MD024": { "siblings_only": true }, // Multiple headings with the same content: | ||
|
||
"MD033": false, // Inline HTML: we use it in some places | ||
|
||
"MD034": false, // Bare URL: we use it in some places in generated docs e.g. | ||
// codersdk/deployment.go L597, L1177, L2287, L2495, L2533 | ||
// codersdk/workspaceproxy.go L196, L200-L201 | ||
// coderd/tracing/exporter.go L26 | ||
// cli/exp_scaletest.go L-9 | ||
|
||
"MD041": false, // First line in file should be a top level heading: All of our changelogs do not start with a top level heading | ||
// TODO: We need to update /home/coder/repos/coder/coder/scripts/release/generate_release_notes.sh to generate changelogs that follow this rule | ||
|
||
"MD052": false, // Image reference: Not a valid reference in generated docs | ||
// docs/reference/cli/server.md L628 | ||
|
||
"MD055": false, // Table pipe style: Some of the generated tables do not have ending pipes | ||
// docs/reference/api/schema.md | ||
// docs/reference/api/templates.md | ||
// docs/reference/cli/server.md | ||
|
||
"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. | ||
// docs/reference/api/schema.md | ||
// docs/reference/api/templates.md | ||
} |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
{ | ||
"recommendations": [ | ||
"biomejs.biome", | ||
"bradlc.vscode-tailwindcss", | ||
"DavidAnson.vscode-markdownlint", | ||
"EditorConfig.EditorConfig", | ||
"emeraldwalk.runonsave", | ||
"foxundermoon.shell-format", | ||
"github.vscode-codeql", | ||
"golang.go", | ||
"hashicorp.terraform", | ||
"esbenp.prettier-vscode", | ||
"foxundermoon.shell-format", | ||
"emeraldwalk.runonsave", | ||
"zxh404.vscode-proto3", | ||
"redhat.vscode-yaml", | ||
"tekumara.typos-vscode", | ||
"EditorConfig.EditorConfig", | ||
"biomejs.biome", | ||
"bradlc.vscode-tailwindcss" | ||
"zxh404.vscode-proto3" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
[https://coder.com/docs/coder-oss/latest/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT) | ||
<!-- markdownlint-disable MD041 --> | ||
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
https://coder.com/docs/CONTRIBUTING | ||
<!-- markdownlint-disable MD041 --> | ||
[https://coder.com/docs/CONTRIBUTING](https://coder.com/docs/CONTRIBUTING) |
Oops, something went wrong.