search

os-climate / itr-data-pipeline

Produce data for ITR tool using data from Data Commons
Apache License 2.0
3 stars 4 forks source link

Documentation failing markdown linting checks #35

Closed ModeSevenIndustrialSolutions closed 6 months ago

ModeSevenIndustrialSolutions commented 6 months ago

Documentation Updates Required

Submit a new PR to this repository.

Pre-commit linting is failing, as shown below.

markdownlint.............................................................Failed
- hook id: markdownlint
- exit code: 1

.github/ISSUE_TEMPLATE/bug_report.md:7 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "**Describe the bug**"]
.github/ISSUE_TEMPLATE/feature_request.md:7 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "**Is your feature request rela..."]
.github/ISSUE_TEMPLATE/patch-release.md:13 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "IMPORTANT NOTES"]
.github/ISSUE_TEMPLATE/patch-release.md:17:301 MD013/line-length Line length [Expected: 300; Actual: 370]
.github/ISSUE_TEMPLATE/redeliver_container_image.md:15 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "IMPORTANT NOTES"]
(node:84507) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
.github/ISSUE_TEMPLATE/major-release.md:13 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "IMPORTANT NOTES"]
.github/ISSUE_TEMPLATE/major-release.md:17:301 MD013/line-length Line length [Expected: 300; Actual: 370]
.github/ISSUE_TEMPLATE/minor-release.md:13 MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading [Context: "IMPORTANT NOTES"]
.github/ISSUE_TEMPLATE/minor-release.md:17:301 MD013/line-length Line length [Expected: 300; Actual: 370]
.github/PULL_REQUEST_TEMPLATE/POLISH_TEMPLATE.md:6 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Related Issues and Dependen..."]
README.md:3:301 MD013/line-length Line length [Expected: 300; Actual: 904]
README.md:20:301 MD013/line-length Line length [Expected: 300; Actual: 458]
README.md:28:32 MD033/no-inline-html Inline HTML [Element: a]
README.md:28:1 MD033/no-inline-html Inline HTML [Element: p]
README.md:28:4 MD033/no-inline-html Inline HTML [Element: small]
(node:84508) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
.github/PULL_REQUEST_TEMPLATE/SIMPLE_TEMPLATE.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Related Issues and Dependen..."]
manifests/README.md:28:301 MD013/line-length Line length [Expected: 300; Actual: 342]
manifests/README.md:35:301 MD013/line-length Line length [Expected: 300; Actual: 412]
manifests/README.md:52:301 MD013/line-length Line length [Expected: 300; Actual: 332]
(node:84509) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
ModeSevenIndustrialSolutions commented 6 months ago

I've addressed all the linting issues here, and disabled the line-length check in devops repo upstream, as it seems overly pedantic.