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

CI: run markdown linter on all pages + fixes #3032

Merged
merged 2 commits into from
Jul 14, 2023

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Jul 14, 2023

Preview: This PR touches many files. Just poke around, in particular, have a look at:

@chalin chalin requested review from a team and mx-psi and removed request for a team July 14, 2023 00:10
@chalin chalin force-pushed the chalin-im-markdown-lint-2023-07-13 branch from 16e8f62 to c819b91 Compare July 14, 2023 00:15
@@ -3,75 +3,74 @@ title: Benchmarks
weight: 99
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Best to review this file while ignoring whitespace in the diff. While the HTML was unindented, only a few other tweaks were done to this page.

@chalin
Copy link
Contributor Author

chalin commented Jul 14, 2023

From this log, you can see that the markdown check runs in 4.36 s (less than 30 for the entire job including installation of packages), https://github.com/open-telemetry/opentelemetry.io/actions/runs/5549104404/jobs/10132809311:

Run npm run check:markdown

> check:markdown
> npx gulp lint-md

[00:16:21] Using gulpfile ~/work/opentelemetry.io/opentelemetry.io/gulpfile.js
[00:16:21] Starting 'lint-md'...
Processed 293 files, 0 had issues.
[00:16:26] Finished 'lint-md' after 4.36 s

@chalin
Copy link
Contributor Author

chalin commented Jul 14, 2023

For the content files, spread across SIGs, only a few minor copyedits were done and/or a some markdownlint directives were added, so I'm going to merge now. Feedback, if any, I'll address in followup PRs.

@chalin chalin merged commit bdca9aa into open-telemetry:main Jul 14, 2023
@chalin chalin deleted the chalin-im-markdown-lint-2023-07-13 branch July 14, 2023 00:51
@chalin chalin mentioned this pull request Aug 1, 2023
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CI: check file formatting, including markdown
3 participants