Skip to content
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

[editorial] Add use of markdownlint-cli2 for linting, wrap some URLs in angle brackets #6251

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Feb 8, 2025

Note

Editorial chang only, consisting of adding <...> around certain URLs

  • Formats markdown links containing calls to Hugo shortcodes using the <...> syntax so that the standard markdownlint tool can process such files
  • Adds a script (check:markdown2) to invoke and dependencies for markdownlint-cli2. We'll ke this as a separate NPM script until I've ported the custom filter for use with markdownlint-cli2

Before running the formatted, there were no significant changes to the generated site files:

$ (cd public && g diff -bw -I 'prettier-ignore') | grep ^diff
diff --git a/site/index.html b/site/index.html

Important

From now on, if a URL contains a call to a Hugo shortcode, you must enclose the URL in angle brackets <...>.

@chalin chalin added CI/infra CI & infrastructure cleanup/refactoring labels Feb 8, 2025
@chalin chalin requested a review from a team as a code owner February 8, 2025 04:06
@opentelemetrybot opentelemetrybot requested review from a team February 8, 2025 04:06
@opentelemetrybot opentelemetrybot requested review from TylerHelmuth and removed request for a team February 8, 2025 04:06
@chalin chalin changed the title [chore] Prepare of use of markdownlint-cli2 [chore] Add use of markdownlint-cli2 for linting Feb 8, 2025
@chalin chalin changed the title [chore] Add use of markdownlint-cli2 for linting [editorial] Add use of markdownlint-cli2 for linting, wrap some URLs in angle brackets Feb 8, 2025
```console
$ (cd public && g diff -bw -I 'prettier-ignore') | grep ^diff
diff --git a/site/index.html b/site/index.html
```
@chalin chalin force-pushed the chalin-im-markdown-lint-2025-02-07 branch from 61d3dcb to 251f8ac Compare February 10, 2025 07:50
@opentelemetrybot opentelemetrybot requested a review from a team February 10, 2025 07:50
@opentelemetrybot opentelemetrybot requested review from a team February 10, 2025 07:50
@chalin chalin merged commit 5472965 into open-telemetry:main Feb 10, 2025
18 checks passed
@chalin chalin deleted the chalin-im-markdown-lint-2025-02-07 branch February 10, 2025 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants