8000 chore: adopt markdownlint and markdown-table-formatter for *.md by matifali · Pull Request #15831 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 94 commits into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
94 commits
Select commit Hold shift + click to select a range
fe34c79
disable prettier for docs md
EdwardAngert Nov 25, 2024
5d1429a
make fmt
EdwardAngert Nov 25, 2024
a8b2217
fix md in jfrog-artifactory
EdwardAngert Nov 25, 2024
8df4ea1
Merge remote-tracking branch 'origin/main' into 216-disable-prettier-…
Dec 5, 2024
819074c
add markdownlint-cli2 and rules
Dec 5, 2024
150fdef
make fmt
Dec 5, 2024
4a1fb29
fix typo
Dec 5, 2024
acee64b
alt text to contributors
Dec 5, 2024
9109a7e
Apply suggestions from code review
EdwardAngert Dec 6, 2024
a6b8f83
move action; remove output format
Dec 6, 2024
6e8aa60
link fixes
Dec 6, 2024
9f14438
fixes and ignore no-bare-urls
Dec 6, 2024
40a94f1
md fixes
Dec 6, 2024
43435a5
add changed.yml
Dec 9, 2024
1da5f23
md lint changed files
Dec 9, 2024
59a92c9
remove redundancy from docs-pr.yaml
Dec 9, 2024
34ca8cb
mdlinter ignore docs/reference
EdwardAngert Dec 10, 2024
4dc14ea
fix errors
EdwardAngert Dec 10, 2024
b7331df
Merge branch 'main' into 216-disable-prettier-docs-md
matifali Dec 11, 2024
fcaa917
Integrate markdownlint and remove Prettier for docs
matifali Dec 11, 2024
e9431a6
Refactor docs lint workflow in docs-lint.yaml
matifali Dec 11, 2024
2f84e0f
Update docs lint workflow to include site directory
matifali Dec 11, 2024
e3ac0b1
Add packageManager to site package.json
matifali Dec 11, 2024
9ccfcfd
Refactor actions and workflows for consistency
matifali Dec 11, 2024
7d5b411
Remove pnpm-lock.yaml from version control
matifali Dec 11, 2024
3b396d3
Fix markdown lint issues in docs and Makefile
matifali Dec 11, 2024
44ceda1
Remove comment line handling in example parsing
matifali Dec 11, 2024
847a8f3
Quote markdownlint path globs in Makefile
matifali Dec 11, 2024
4ed47fc
Fix formatting in provisionerGenerated.ts
matifali Dec 11, 2024
89fec9a
Merge remote-tracking branch 'origin/main' into 216-disable-prettier-…
EdwardAngert Dec 11, 2024
6d5006a
Refactor TypeScript formatting target in Makefile
matifali Dec 12, 2024
0471071
Refactor Makefile to rename fmt/ts to fmt/biome
matifali Dec 12, 2024
981d7b5
Refactor documentation for consistency in formatting
matifali Dec 12, 2024
d11102a
Rename docs-lint.yaml to docs-ci.yaml
matifali Dec 12, 2024
e14d543
Discard changes to .github/actions/setup-node/action.yaml
matifali Dec 12, 2024
f1305d0
Discard changes to coderd/prometheusmetrics/testdata/agent-stats.json
matifali Dec 12, 2024
3670fa7
Discard changes to coderd/prometheusmetrics/insights/testdata/insight…
matifali Dec 12, 2024
e1eec2f
revert non-docs chnages
matifali Dec 12, 2024
f3652f7
remove prettier
matifali Dec 12, 2024
34ceccf
ignore examples.gen.json
matifali Dec 12, 2024
868d3fa
Merge branch '216-disable-prettier-docs-md' into atif/bye-bye-prettier
matifali Dec 12, 2024
3c2c4da
Merge branch 'main' into atif/bye-bye-prettier
matifali Dec 12, 2024
8cdd668
Update markdown formatting tools and apply fixes
matifali Dec 12, 2024
223cd4d
ci: specify workspace directory in setup-node action
matifali Dec 12, 2024
6de5e1d
Add Storybook launch script to package.json
matifali Dec 12, 2024
2ed285f
Rename docs lint workflow to docs CI
matifali Dec 12, 2024
eb3504c
Remove redundant setup-node configuration
matifali Dec 12, 2024
7b7308b
Add echo for changed files in docs CI workflow
matifali Dec 12, 2024
95d5574
Fix workflow environment variable syntax in docs CI
matifali Dec 12, 2024
d8fb439
Swap lint and fmt steps in docs workflow
matifali Dec 12, 2024
db200bb
Rename workflow job to 'docs' in docs-ci.yaml
matifali Dec 12, 2024
60a5a4a
Improve markdown formatting consistency
matifali Dec 12, 2024
691cf5c
Refactor JSON example tags formatting and add comment
matifali Dec 12, 2024
c9afb8b
Add generated examples for various environments
matifali Dec 12, 2024
79abf5f
Merge branch 'main' into atif/bye-bye-prettier
matifali Dec 17, 2024
7a326bd
`make fmt`
matifali Dec 17, 2024
f6c652a
Resolve merge conflict by incorporating both suggestions
matifali Dec 23, 2024
ab64ced
fix glob
matifali Dec 23, 2024
fd042dd
fix glob
matifali Dec 23, 2024
c9bc320
fixup: remove extra examples.gen.json from root
matifali Dec 23, 2024
a38312a
JSON do not have commnets
matifali Dec 23, 2024
3417860
remove target for ignored file
matifali Dec 23, 2024
bd31583
make -B
matifali Dec 23, 2024
9b0f28a
fixup
matifali Dec 24, 2024
917d6b3
Merge branch 'main' into atif/bye-bye-prettier
matifali Dec 24, 2024
ad73e4e
fixup
matifali Dec 24, 2024
90acaca
Reorder and update VSCode extension recommendations
matifali Dec 27, 2024
979a283
enable more rules
matifali Dec 27, 2024
34aa71b
Merge branch 'main' into atif/bye-bye-prettier
matifali Dec 27, 2024
6abc05a
make gen
matifali Dec 27, 2024
a291686
make fmt
matifali Dec 27, 2024
a61d20d
golden files
matifali Dec 30, 2024
e384d0a
Merge branch 'main' into atif/bye-bye-prettier
matifali Dec 30, 2024
f0cb88d
Update URLs to angle brackets for Markdown
matifali Dec 30, 2024
4e83922
Update codersdk/deployment.go
matifali Dec 31, 2024
504a1ed
Update docs/changelogs/v2.1.1.md
matifali Dec 31, 2024
4cea376
Update docs/changelogs/v2.5.0.md
matifali Dec 31, 2024
1637783
Merge branch 'main' into atif/bye-bye-prettier
matifali Dec 31, 2024
5392bb7
fix heading levels in IDP sync documentation
matifali Dec 31, 2024
15f21eb
Update docs CI workflow for specific file paths
matifali Dec 31, 2024
b733ad1
Format code examples in docs with backticks
matifali Dec 31, 2024
0d41834
Update workflow paths for consistent globbing
matifali Dec 31, 2024
f97ce22
Merge branch 'main' into atif/bye-bye-prettier
matifali Jan 2, 2025
687b015
wip
matifali Jan 2, 2025
fe265eb
wip 2
matifali Jan 2, 2025
33f4b81
fixup
matifali Jan 2, 2025
11dd374
Update markdownlint config for schema and templates docs
matifali Jan 2, 2025
43f568b
Merge branch 'main' into atif/bye-bye-prettier
matifali Jan 3, 2025
dadc689
make -B gen
matifali Jan 3, 2025
c375423
Delete coderd/database/dbmock/gomock_reflect_2684282611/prog.go
matifali Jan 3, 2025
6b95860
make -B gen
matifali Jan 3, 2025
8fefeef
make -B gen
matifali Jan 3, 2025
8731666
make update-golden-files
matifali Jan 3, 2025
9f6adaa
fixup
matifali Jan 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
golden files
  • Loading branch information
matifali committed Dec 30, 2024
commit a61d20de0470d11ddf01652358254f03f72102be
16 changes: 8 additions & 8 deletions cli/testdata/coder_server_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ OPTIONS:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These files must not be changed, probably best to not touch anything in any testdata folder. Although, if they changed as a result of changing the Go files then that's OK.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the best way to do that?
These files are generated from code and so does the API and CLI docs. And to make the docs follow the rules this is an artifact.

I will further explore how best to deal with this.

--postgres-url string, $CODER_PG_CONNECTION_URL
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be
downloaded from Maven (https://repo1.maven.org/maven2) and store all
downloaded from Maven <https://repo1.maven.org/maven2> and store all
data in the config root. Access the built-in database with "coder
server postgres-builtin-url". Note that any special characters in the
URL must be URL-encoded.
Expand All @@ -82,8 +82,8 @@ Clients include the coder cli, vs code extension, and the web UI.

--cli-upgrade-message string, $CODER_CLI_UPGRADE_MESSAGE
The upgrade message to display to users when a client/server mismatch
is detected. By default it instructs users to update using 'curl -L
https://coder.com/install.sh | sh'.
is detected. By default it instructs users to update using `curl -L
https://coder.com/install.sh | sh`.

--ssh-config-options string-array, $CODER_SSH_CONFIG_OPTIONS
These SSH config options will override the default SSH config options.
Expand Down Expand Up @@ -215,7 +215,7 @@ INTROSPECTION / TRACING OPTIONS:
--trace bool, $CODER_TRACE_ENABLE
Whether application tracing data is collected. It exports to a backend
configured by environment variables. See:
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md>.

--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY
Enables trace exporting to Honeycomb.io using the provided API Key.
Expand Down Expand Up @@ -269,11 +269,11 @@ backed by Tailscale and WireGuard.

--derp-config-path string, $CODER_DERP_CONFIG_PATH
Path to read a DERP mapping from. See:
https://tailscale.com/kb/1118/custom-derp-servers/.
<https://tailscale.com/kb/1118/custom-derp-servers/>.

--derp-config-url string, $CODER_DERP_CONFIG_URL
URL to fetch a DERP mapping on startup. See:
https://tailscale.com/kb/1118/custom-derp-servers/.
<https://tailscale.com/kb/1118/custom-derp-servers/>.

--derp-force-websockets bool, $CODER_DERP_FORCE_WEBSOCKETS
Force clients and agents to always use WebSocket to connect to DERP
Expand Down Expand Up @@ -355,7 +355,7 @@ can safely ignore these settings.
--tls-allow-insecure-ciphers bool, $CODER_TLS_ALLOW_INSECURE_CIPHERS (default: false)
By default, only ciphers marked as 'secure' are allowed to be used.
See
https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95.
<https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95>.

--tls-cert-file string-array, $CODER_TLS_CERT_FILE
Path to each certificate for TLS. It requires a PEM-encoded file. To
Expand All @@ -365,7 +365,7 @@ can safely ignore these settings.

--tls-ciphers string-array, $CODER_TLS_CIPHERS
Specify specific TLS ciphers that allowed to be used. See
https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75.
<https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75>.

--tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none)
Policy the server will follow for TLS Client Authentication. Accepted
Expand Down
22 changes: 11 additions & 11 deletions cli/testdata/server-config.yaml.golden
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ networking:
# (default: <unset>, type: string)
clientKeyFile: ""
# Specify specific TLS ciphers that allowed to be used. See
# https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75.
# <https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75>.
# (default: <unset>, type: string-array)
tlsCiphers: []
# By default, only ciphers marked as 'secure' are allowed to be used. See
# https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95.
# <https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95>.
# (default: false, type: bool)
tlsAllowInsecureCiphers: false
# Controls if the 'Strict-Transport-Security' header is set on all static file
Expand Down Expand Up @@ -157,11 +157,11 @@ networking:
# (default: <unset>, type: bool)
forceWebSockets: false
# URL to fetch a DERP mapping on startup. See:
# https://tailscale.com/kb/1118/custom-derp-servers/.
# <https://tailscale.com/kb/1118/custom-derp-servers/>.
# (default: <unset>, type: string)
url: ""
# Path to read a DERP mapping from. See:
# https://tailscale.com/kb/1118/custom-derp-servers/.
# <https://tailscale.com/kb/1118/custom-derp-servers/>.
# (default: <unset>, type: string)
configPath: ""
# Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip,
Expand Down Expand Up @@ -217,7 +217,7 @@ introspection:
tracing:
# Whether application tracing data is collected. It exports to a backend
# configured by environment variables. See:
# https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
# <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md>.
# (default: <unset>, type: bool)
enable: false
# Enables capturing of logs as events in traces. This is useful for debugging, but
Expand Down Expand Up @@ -459,8 +459,8 @@ termsOfServiceURL: ""
# (default: ed25519, type: string)
sshKeygenAlgorithm: ed25519
# URL to use for agent troubleshooting when not set in the template.
# (default: https://coder.com/docs/templates/troubleshooting, type: url)
agentFallbackTroubleshootingURL: https://coder.com/docs/templates/troubleshooting
# (default: https://coder.com/docs/admin/templates/troubleshooting, type: url)
agentFallbackTroubleshootingURL: https://coder.com/docs/admin/templates/troubleshooting
# Disable workspace apps that are not served from subdomains. Path-based apps can
# make requests to the Coder API and pose a security risk when the workspace
# serves malicious JavaScript. This is recommended for security purposes if a
Expand All @@ -485,8 +485,8 @@ client:
# (default: <unset>, type: string-array)
sshConfigOptions: []
# The upgrade message to display to users when a client/server mismatch is
# detected. By default it instructs users to update using 'curl -L
# https://coder.com/install.sh | sh'.
# detected. By default it instructs users to update using `curl -L
# https://coder.com/install.sh | sh`.
# (default: <unset>, type: string)
cliUpgradeMessage: ""
# The renderer to use when opening a web terminal. Valid values are 'canvas',
Expand All @@ -499,9 +499,9 @@ supportLinks: []
# External Authentication providers.
# (default: <unset>, type: struct[[]codersdk.ExternalAuthConfig])
externalAuthProviders: []
# Hostname of HTTPS server that runs https://github.com/coder/wgtunnel. By
# Hostname of HTTPS server that runs <https://github.com/coder/wgtunnel>. By
# default, this will pick the best available wgtunnel server hosted by Coder. e.g.
# "tunnel.example.com".
# <tunnel.example.com>.
# (default: <unset>, type: string)
wgtunnelHost: ""
# Allow users to set quiet hours schedules each day for workspaces to avoid
Expand Down
16 changes: 8 additions & 8 deletions enterprise/cli/testdata/coder_server_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ OPTIONS:

--postgres-url string, $CODER_PG_CONNECTION_URL
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be
downloaded from Maven (https://repo1.maven.org/maven2) and store all
downloaded from Maven <https://repo1.maven.org/maven2> and store all
data in the config root. Access the built-in database with "coder
server postgres-builtin-url". Note that any special characters in the
URL must be URL-encoded.
Expand All @@ -83,8 +83,8 @@ Clients include the coder cli, vs code extension, and the web UI.

--cli-upgrade-message string, $CODER_CLI_UPGRADE_MESSAGE
The upgrade message to display to users when a client/server mismatch
is detected. By default it instructs users to update using 'curl -L
https://coder.com/install.sh | sh'.
is detected. By default it instructs users to update using `curl -L
https://coder.com/install.sh | sh`.

--ssh-config-options string-array, $CODER_SSH_CONFIG_OPTIONS
These SSH config options will override the default SSH config options.
Expand Down Expand Up @@ -216,7 +216,7 @@ INTROSPECTION / TRACING OPTIONS:
--trace bool, $CODER_TRACE_ENABLE
Whether application tracing data is collected. It exports to a backend
configured by environment variables. See:
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md>.

--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY
Enables trace exporting to Honeycomb.io using the provided API Key.
Expand Down Expand Up @@ -270,11 +270,11 @@ backed by Tailscale and WireGuard.

--derp-config-path string, $CODER_DERP_CONFIG_PATH
Path to read a DERP mapping from. See:
https://tailscale.com/kb/1118/custom-derp-servers/.
<https://tailscale.com/kb/1118/custom-derp-servers/>.

--derp-config-url string, $CODER_DERP_CONFIG_URL
URL to fetch a DERP mapping on startup. See:
https://tailscale.com/kb/1118/custom-derp-servers/.
<https://tailscale.com/kb/1118/custom-derp-servers/>.

--derp-force-websockets bool, $CODER_DERP_FORCE_WEBSOCKETS
Force clients and agents to always use WebSocket to connect to DERP
Expand Down Expand Up @@ -356,7 +356,7 @@ can safely ignore these settings.
--tls-allow-insecure-ciphers bool, $CODER_TLS_ALLOW_INSECURE_CIPHERS (default: false)
By default, only ciphers marked as 'secure' are allowed to be used.
See
https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95.
<https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95>.

--tls-cert-file string-array, $CODER_TLS_CERT_FILE
Path to each certificate for TLS. It requires a PEM-encoded file. To
Expand All @@ -366,7 +366,7 @@ can safely ignore these settings.

--tls-ciphers string-array, $CODER_TLS_CIPHERS
Specify specific TLS ciphers that allowed to be used. See
https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75.
<https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75>.

--tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none)
Policy the server will follow for TLS Client Authentication. Accepted
Expand Down
Loading
0