Lewis John McGibbney created NUTCH-3218:
-------------------------------------------
Summary: Resolve markdownlint findings in plugin docs and
repository markdown
Key: NUTCH-3218
URL: https://issues.apache.org/jira/browse/NUTCH-3218
Project: Nutch
Issue Type: Improvement
Components: documentation
Affects Versions: 1.23
Reporter: Lewis John McGibbney
Assignee: Lewis John McGibbney
Fix For: 1.24
Master Yetus run 36915201085 reports 184 markdownlint lines (markdownlint-cli
0.44.0). 173 are rule findings in 22 files. The other 11 lines are a
markdownlint-cli crash: {{{}Value of 'fixInfo.editColumn' passed to onError by
'MD005' is incorrect for 'CHANGES.md'{}}}. Do not edit {{{}CHANGES.md{}}}. Keep
that file out of the markdownlint scan so the crash cannot hold the vote at -1.
{{.markdownlint.yaml}} is already committed and is in effect (MD013 expects 200
columns, matching {{{}line_length: 200{}}}). Remaining rules on top of that
config:
* MD013 line length (34)
* MD007 unordered-list indent (26)
* MD004 ul style (14)
* MD040 fenced code language (14)
* MD055 table-pipe style (14)
* MD056 table column count (14)
* MD032 lists surrounded by blanks (12)
* MD031 fenced code blanks (9)
* MD029 ordered-list prefix (9)
Largest file is {{src/plugin/protocol-selenium/README.md}} (54). Other hot
files: {{indexer-opensearch-1x/README.md}} (14), {{indexer-rabbit/README.md}}
(11), {{indexer-cloudsearch/README.md}} (10),
{{lib-selenium/howto_upgrade_selenium.md}} (9),
{{.github/pull_request_template.md}} (8), {{indexer-solr/README.md}} (8), and
{{THREAT_MODEL.md}} (7).
Either reformat those files to the rules already in {{{}.markdownlint.yaml{}}},
or extend that config to record the Nutch style and only fix real mistakes. Do
not mix a new relaxation with a drive-by reformat of all 173 findings in one
patch unless the config makes the rest pass.
No functional change intended.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
