Skip to content

Commit

Permalink
fix: vale errors
Browse files Browse the repository at this point in the history
  • Loading branch information
themr0c committed Oct 21, 2021
1 parent f1253cd commit 13408d0
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 36 deletions.
28 changes: 9 additions & 19 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
9 changes: 9 additions & 0 deletions .vale/styles/RedHat/README-IBM.adoc
Original file line number Diff line number Diff line change
@@ -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]
1 change: 1 addition & 0 deletions .vale/styles/RedHat/README-write-good.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- vale off -->
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.
Expand Down
4 changes: 0 additions & 4 deletions .vale/styles/RedHat/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 0 additions & 7 deletions red-hat.md

This file was deleted.

0 comments on commit 13408d0

Please sign in to comment.