[TEZ-4588] Address markdownlint warnings in docs module

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Assignee: Unassigned
• Reporter: László Bodor
• Created: 16/Nov/24 15:13
• Updated: 16/Nov/24 15:16

Description

While adding new release files (with the very same form), there are markdownlint warnings like:

docs/src/site/markdown/releases/apache-tez-0-10-2.md:20:0:MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "Apache TEZ® 0.10.2"]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:26:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:26:81:MD013/line-length Line length [Expected: 80; Actual: 89]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:27:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:27:81:MD013/line-length Line length [Expected: 80; Actual: 198]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:28:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:28:81:MD013/line-length Line length [Expected: 80; Actual: 204]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:29:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:29:81:MD013/line-length Line length [Expected: 80; Actual: 185]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:30:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-2.md:30:81:MD013/line-length Line length [Expected: 80; Actual: 222]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:18:1:MD033/no-inline-html Inline HTML [Element: head]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:20:0:MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "Apache TEZ® 0.10.3"]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:26:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:26:81:MD013/line-length Line length [Expected: 80; Actual: 89]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:27:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:27:81:MD013/line-length Line length [Expected: 80; Actual: 198]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:28:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:28:81:MD013/line-length Line length [Expected: 80; Actual: 204]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:29:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:29:81:MD013/line-length Line length [Expected: 80; Actual: 185]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:30:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-3.md:30:81:MD013/line-length Line length [Expected: 80; Actual: 222]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:18:1:MD033/no-inline-html Inline HTML [Element: head]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:20:0:MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "Apache TEZ® 0.10.4"]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:26:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:26:81:MD013/line-length Line length [Expected: 80; Actual: 89]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:27:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:27:81:MD013/line-length Line length [Expected: 80; Actual: 198]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:28:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:28:81:MD013/line-length Line length [Expected: 80; Actual: 204]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:29:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:29:81:MD013/line-length Line length [Expected: 80; Actual: 185]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:30:1:MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
docs/src/site/markdown/releases/apache-tez-0-10-4.md:30:81:MD013/line-length Line length [Expected: 80; Actual: 222]
docs/src/site/markdown/releases/index.md:18:1:MD033/no-inline-html Inline HTML [Element: head]
docs/src/site/markdown/releases/index.md:22:0:MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "-   [Apache TEZ® 0.10.4](...."]
docs/src/site/markdown/releases/index.md:23:1:MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/src/site/markdown/releases/index.md:24:1:MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]
docs/src/site/markdown/releases/index.md:25:1:MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3]

they should be handled together for not only the new, but the old files as well

Issue Links

• Discovered while testing: TEZ-4587 Synchronize Tez site with the current markup