From 13408d002ab1f6569e914fca9f9b516d45530e8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 21 Oct 2021 10:30:13 +0200 Subject: [PATCH] fix: vale errors --- .github/ISSUE_TEMPLATE/bug_report.md | 28 ++++++------------- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++-- .vale/styles/RedHat/README-IBM.adoc | 9 ++++++ .vale/styles/RedHat/README-write-good.md | 1 + .vale/styles/RedHat/README.md | 4 --- README.adoc | 2 +- .../proc_extending-the-spelling-rule.adoc | 2 +- .../proc_using-vale-github-action.adoc | 5 +++- red-hat.md | 7 ----- 9 files changed, 28 insertions(+), 36 deletions(-) create mode 100644 .vale/styles/RedHat/README-IBM.adoc delete mode 100644 .vale/styles/RedHat/README.md delete mode 100644 red-hat.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e12b1b3bf..7a2f32866 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,29 +10,19 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. +Examples: + +* This word or expression triggers an illegitimate vale alert. +* This word or expression triggers an ambiguous vale alert. + **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '...' -3. Scroll down to '...' -4. See the error + +1. Add this word or expression: +2. Vale reports an illegitimate alert: error, warning, suggestion. **Expected behavior** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (complete the following information):** - - Operating system: [for example iOS] - - Browser [for example chrome, safari] - - Version [for example 22] - -**Smartphone (complete the following information):** - - Device: [for example iPhone6] - - Operating system: [for example iOS8.1] - - Browser [for example stock browser, safari] - - Version [for example 22] - **Additional context** -Add any other context about the problem here. +Add any other context here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f9b09b1ee..3fc6f43b8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,13 +8,13 @@ assignees: '' --- **Is your feature request related to a problem? Describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. -**Describe the solution you'd like** +**Describe the solution you'd propose** A clear and concise description of what you want to happen. **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. **Additional context** -Add any other context or screenshots about the feature request here. +Add any other context or screenshots here. diff --git a/.vale/styles/RedHat/README-IBM.adoc b/.vale/styles/RedHat/README-IBM.adoc new file mode 100644 index 000000000..7e27b01a6 --- /dev/null +++ b/.vale/styles/RedHat/README-IBM.adoc @@ -0,0 +1,9 @@ += README for Rules from the IBM Style Guide + +All rights for the IBM Style Guide belong to IBM. + +Our sources of inspiration: + +* link:https://github.com/errata-ai/IBM[The primary Vale implementation of the IBM Style Guide] + +* https://www.ibm.com/developerworks/library/styleguidelines/index.html[The DeveloperWorks version of the IBM Style Guide] diff --git a/.vale/styles/RedHat/README-write-good.md b/.vale/styles/RedHat/README-write-good.md index 3edcc9b37..ba919b6fe 100644 --- a/.vale/styles/RedHat/README-write-good.md +++ b/.vale/styles/RedHat/README-write-good.md @@ -1,3 +1,4 @@ + Based on [write-good](https://github.com/btford/write-good). > Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. diff --git a/.vale/styles/RedHat/README.md b/.vale/styles/RedHat/README.md deleted file mode 100644 index c11ce5015..000000000 --- a/.vale/styles/RedHat/README.md +++ /dev/null @@ -1,4 +0,0 @@ -IBM Style Guide was created by IBM : https://www.ibm.com/developerworks/library/styleguidelines/index.html -All rights for the style guide belong to IBM. - -Rules were compiled at: https://github.com/errata-ai/IBM diff --git a/README.adoc b/README.adoc index 9507569b0..a69bac40f 100644 --- a/README.adoc +++ b/README.adoc @@ -1,6 +1,6 @@ # Studious-fortnight repository -This repository helps tech writers at Red Hat get up and running with Vale. It serves as the starting point for the Vale Community of Practice at Red Hat. +This repository helps tech writers at Red Hat get up and running with Vale. It is the starting point for the Vale Community of Practice at Red Hat. * See the documentation: link:https://rolfedh.github.io/studious-fortnight/[Vale for Red Hat documentation writers] diff --git a/modules/end-user-guide/partials/proc_extending-the-spelling-rule.adoc b/modules/end-user-guide/partials/proc_extending-the-spelling-rule.adoc index 846e6eab1..9d20eb9cf 100644 --- a/modules/end-user-guide/partials/proc_extending-the-spelling-rule.adoc +++ b/modules/end-user-guide/partials/proc_extending-the-spelling-rule.adoc @@ -55,7 +55,7 @@ $ vale . . Vale should: + * Report no error for the new term in the `testvalid.adoc` file -* Optionnally, report an error for the new term in the `testinvalid.adoc` file +* Optionally, report an error for the new term in the `testinvalid.adoc` file .Additional resources diff --git a/modules/end-user-guide/partials/proc_using-vale-github-action.adoc b/modules/end-user-guide/partials/proc_using-vale-github-action.adoc index 1ed8f4b07..e21400871 100644 --- a/modules/end-user-guide/partials/proc_using-vale-github-action.adoc +++ b/modules/end-user-guide/partials/proc_using-vale-github-action.adoc @@ -3,7 +3,10 @@ [id="proc_using-vale-github-action_{context}"] = Using vale GitHub Action -Consider using vale GitHub Action when your repository is hosted on GitHub, to measure or enforce the project compliance with the Style Guides. +Consider using vale GitHub Action when: + +* The content repository is on GitHub. +* The goal is to measure or enforce the project compliance with the Style Guides. WARNING: Due to the GitHub token permissions, this Action can not post annotations to PRs from forked repositories. diff --git a/red-hat.md b/red-hat.md deleted file mode 100644 index f8e7787b6..000000000 --- a/red-hat.md +++ /dev/null @@ -1,7 +0,0 @@ -# `red-hat` style - -The `red-hat` style is based on the [Eclipse Che documentation project](https://github.com/eclipse/che-docs/). - -Yana and Fabrice created this style from the [the IBM style](https://github.com/errata-ai/IBM) and other sources. - -WIP - TBD - say more.