elharo opened a new pull request, #719:
URL: https://github.com/apache/maven-checkstyle-plugin/pull/719
## Purpose
Rewrite the prose in the plugin's site markdown pages according to
ASD-STE100 Simplified Technical English so that the documentation is easier to
read for non-native speakers and for machine translation.
## Changes
- Rewrote prose in all 11 markdown pages under `src/site/markdown` (plus the
two hand-written example pages). The `history.md.vm` page contains only a data
table and Velocity macros, so it is unchanged.
- Use simple tenses, active voice, and imperative mood for instructions.
- Keep only the approved modals (`can`, `will`, `must`). Replace `should`,
`would`, `may`, `might` with a definite form.
- Remove contractions, semicolons, present perfect, and `-ing` verb forms
from the prose.
- Split long sentences to fit the 20-word (procedural) and 25-word
(descriptive) limits.
- Replace `reporting goal` and `<reporting>` only where the term is prose;
the Maven concepts `reporting goal` and the `mailing list` remain as fixed
terms.
- Align the menu labels in `site.xml` with the new page titles.
- Page titles that used gerunds (for example "Using a Suppressions Filter")
are now noun phrases ("Suppressions Filter"). Links and anchors are unchanged.
## Verification
- Scanned all pages for banned forms: modals, contractions, present perfect,
semicolons, `, making`, and `-ing` verb forms. Only fixed terms remain
(`reporting`, `mailing list`, and the external document title "guide to helping
with Maven").
- Checked sentence lengths per paragraph against the limits.
- Validated that fenced code blocks are balanced, Velocity `#[[...]]#`
escapes are intact, every XML code block still parses, and `site.xml` remains
well-formed.
- Code blocks, identifiers, links, and Velocity references were left
untouched.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
