mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
a81fd9a459
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Remove some markdownlint exceptions: trailing whitespace, hard tabs, consecutive blank lines. Mostly solved by running `markdownlint --fix .` after removing the exceptions, with some manual changes to correct indentation in Go code blocks. Tabs are typical for actual Go code but I've replaced with two spaces here - other option is just keeping the hard tabs exception in. <!-- Issue number if applicable --> #### Link to tracking issue Partially fixes https://github.com/open-telemetry/opentelemetry-collector/issues/14731 #### Testing * ran `markdownlint .` after removing rules and making fixes, verified no issues <!--Describe the documentation added.--> #### Documentation None. Modified existing documentation. --------- Co-authored-by: Alex Boten <[email protected]>
36 lines
1.3 KiB
YAML
36 lines
1.3 KiB
YAML
# markdownlint configuration for OpenTelemetry Collector
|
|
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
|
|
#
|
|
# Start permissive to establish a baseline; tighten rules over time.
|
|
default: true
|
|
|
|
# Disabled rules (existing codebase has many violations)
|
|
MD001: false # heading increment
|
|
MD004: false # unordered list style
|
|
MD007: false # unordered list indentation
|
|
MD013: false # line length
|
|
MD014: false # dollar signs in commands
|
|
MD022: false # blanks around headings
|
|
MD024: false # duplicate headings
|
|
MD025: false # multiple top-level headings
|
|
MD026: false # trailing punctuation in heading
|
|
MD029: false # ordered list prefix
|
|
MD030: false # spaces after list markers
|
|
MD031: false # blanks around fences
|
|
MD032: false # blanks around lists
|
|
MD033: false # inline HTML
|
|
MD034: false # bare URLs
|
|
MD036: false # emphasis as heading
|
|
MD038: false # spaces in code spans
|
|
MD040: false # fenced code language
|
|
MD041: false # first line heading
|
|
MD047: false # single trailing newline
|
|
MD049: false # emphasis style
|
|
MD051: false # link fragments
|
|
MD053: false # unused link definitions
|
|
MD058: false # blanks around tables
|
|
MD059: false # descriptive link text
|
|
MD060: false # table column style
|
|
MD028: false # blank line inside blockquote
|
|
MD037: false # spaces inside emphasis
|