UNCLASSIFIED - NO CUI

Skip to content

SKIP UPDATE CHECK Fix linter errors in README templates

Zach Callahan requested to merge readme-template-lint-fix into master

General MR

Summary

This MR resolves linter violations present in the gluon README templates.

Relevant logs/screenshots

A pipeline run using the old templates:

Markdown File Linting
00:04
Linting with default values using 'markdownlint *.md' --disable MD012 MD013 MD022 MD024 MD031 MD032 MD034
README.md:8 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
README.md:18:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
README.md:19:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
README.md:23:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
README.md:24:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
README.md:25:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
README.md:33:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
README.md:34:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Source: https://repo1.dso.mil/big-bang/product/packages/elasticsearch-kibana/-/jobs/38901691#L40

A pipeline run using the new templates:

Markdown File Linting
00:02
Linting with default values using 'markdownlint *.md' --disable MD012 MD013 MD022 MD024 MD031 MD032 MD034
0

Source: https://repo1.dso.mil/big-bang/product/packages/elasticsearch-kibana/-/jobs/39004322#L43

Linked Issue

This issue mentions different (older) violations, but the fundamental issue is the same: #42 (closed)

Upgrade Notices

N/A

Closes #42 (closed)

Merge request reports