Skip to content

Conversation

@jbampton
Copy link
Member

@jbampton jbampton commented Sep 19, 2025

Description

This PR adds a check / test with markdownlint to make sure we only use one type of Markdown heading in our docs.

https://github.com/DavidAnson/markdownlint/blob/main/doc/md003.md

Use .markdownlintignore for better command line support. Central location and easy to find and maintain

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

With pre-commit and visually checked

How did you try to break this feature and the system with this change?

@codecov
Copy link

codecov bot commented Sep 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 17.55%. Comparing base (b106d6e) to head (de37267).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #11688      +/-   ##
============================================
- Coverage     17.56%   17.55%   -0.01%     
+ Complexity    15517    15515       -2     
============================================
  Files          5906     5906              
  Lines        528377   528377              
  Branches      64528    64528              
============================================
- Hits          92783    92775       -8     
- Misses       425162   425170       +8     
  Partials      10432    10432              
Flag Coverage Δ
uitests 3.59% <ø> (ø)
unittests 18.62% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DaanHoogland
Copy link
Contributor

no code touched @harikrishna-patnala , I think you can merge at will.

@DaanHoogland
Copy link
Contributor

ping @harikrishna-patnala ?

Copy link
Member

@vishesh92 vishesh92 left a comment

Choose a reason for hiding this comment

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

lgtm

@vishesh92 vishesh92 merged commit 349feeb into apache:main Oct 13, 2025
27 of 28 checks passed
@DaanHoogland DaanHoogland added this to the 4.22.0 milestone Oct 13, 2025
@jbampton jbampton deleted the standardize-markdown branch October 14, 2025 08:47
dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Oct 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants