Skip to content

Commit f96829c

Browse files
authored
pre-commit: add markdownlint and fix Markdown linter errors (#40)
Add basic config file to start
1 parent 8ff1d1e commit f96829c

File tree

8 files changed

+40
-3
lines changed

8 files changed

+40
-3
lines changed

.github/linters/.markdown-lint.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# MD013/line-length Line length
2+
MD013: false
3+
4+
# MD007/ul-indent Unordered list indentation
5+
MD007: false
6+
7+
# MD025/single-title/single-h1 Multiple top-level headings in the same document
8+
MD025: false
9+
10+
# MD028/no-blanks-blockquote Blank line inside blockquote
11+
MD028: false
12+
13+
# MD029/ol-prefix Ordered list item prefix
14+
MD029: false
15+
16+
# MD034/no-bare-urls Bare URL used
17+
MD034: false
18+
19+
# MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading
20+
MD041: false
21+
22+
# MD055/table-pipe-style Table pipe style
23+
MD055: false
24+
25+
# MD056/table-column-count Table column count
26+
MD056: false

.pre-commit-config.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,15 @@ repos:
3535
- id: trailing-whitespace
3636
args: [--markdown-linebreak-ext=md]
3737
exclude: \.svg$
38+
- repo: https://github.com/igorshubovych/markdownlint-cli
39+
rev: v0.45.0
40+
hooks:
41+
- id: markdownlint
42+
name: run markdownlint
43+
description: check Markdown files with markdownlint
44+
args: [--config=.github/linters/.markdown-lint.yml]
45+
types: [markdown]
46+
files: \.md$
3847
- repo: https://github.com/adrienverge/yamllint
3948
rev: v1.37.1
4049
hooks:

content/pages/agenda-tool.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ license: https://www.apache.org/licenses/LICENSE-2.0
66
The secondary project is the Board Agenda Tool.
77

88
Repository
9+
910
- https://github.com/apache/tooling-agenda

content/pages/data-model.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Title: Apache Trusted Release Data Model
22
license: https://www.apache.org/licenses/LICENSE-2.0
33

4-
54
_This is a discussion and the actual implementation will diverge._
65

76
Here is an introduction to the ATR's data model.

content/pages/platform.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Title: Apache Trusted Release Platform Services
22
license: https://www.apache.org/licenses/LICENSE-2.0
33

4-
54
_This is a discussion and the actual implementation will diverge._
65

76
https://releases.apache.org

content/pages/team.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@ Title: About the Apache Tooling Team
22
license: https://www.apache.org/licenses/LICENSE-2.0
33

44
# ASF Tooling
5+
56
The ASF Tooling team, known as **Tooling**, provides tooling development for select ASF Initiatives.
67

78
## About us
9+
810
Tooling has a core team made up of a number of paid contractors, whom are senior software engineers; and volunteers. The core team collaborates to develop specific software, work with and contribute to Infra. The volunteers bring their skills to bear on their areas of interest, reducing the load on the core team.
911

1012
## How you can help
13+
1114
Volunteers are the driving force of the ASF. The Tooling team is looking for people willing to help out at whatever effort level suits. If you're interested, visit our [volunteer information](volunteer.html) page.

content/pages/trusted-release.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ license: https://www.apache.org/licenses/LICENSE-2.0
44
The main project is the Apache Trusted Release Platform.
55

66
Repositories:
7+
78
- https://github.com/apache/tooling-trusted-release
89
- https://github.com/apache/tooling-releases-client
910

content/pages/volunteer.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Title: Volunteering for ASF Tooling
22
license: https://www.apache.org/licenses/LICENSE-2.0
33

4-
54
There are opportunities to volunteer to help develop new tooling for the ASF.
65

76
There are some basic things you could do if you're going to help out with the ASF Tooling team.

0 commit comments

Comments
 (0)