Skip to content

Commit 60ddad6

Browse files
authored
Merge pull request #57 from themr0c/one-unique-redistributable-style
One unique redistributable style: *RedHat*
2 parents 3f0c562 + 1f354ad commit 60ddad6

File tree

352 files changed

+620
-369
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

352 files changed

+620
-369
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ A clear and concise description of what the bug is.
1313
**To Reproduce**
1414
Steps to reproduce the behavior:
1515
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
16+
2. Click on '...'
17+
3. Scroll down to '...'
1818
4. See the error
1919

2020
**Expected behavior**
@@ -24,13 +24,13 @@ A clear and concise description of what you expected to happen.
2424
If applicable, add screenshots to help explain your problem.
2525

2626
**Desktop (complete the following information):**
27-
- OS: [for example iOS]
27+
- Operating system: [for example iOS]
2828
- Browser [for example chrome, safari]
2929
- Version [for example 22]
3030

3131
**Smartphone (complete the following information):**
3232
- Device: [for example iPhone6]
33-
- OS: [for example iOS8.1]
33+
- Operating system: [for example iOS8.1]
3434
- Browser [for example stock browser, safari]
3535
- Version [for example 22]
3636

.github/workflows/release.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Release
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
prose:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@master
12+
13+
- name: Create release
14+
run: |
15+
zip -r RedHat.zip .vale/RedHat
16+
gh release create v${{GITHUB_RUN_NUMBER}} 'RedHat.zip'
17+
env:
18+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/vale.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: Linting with Vale
2-
on: [push]
3-
2+
on:
3+
- pull_request
4+
- push
45
jobs:
56
prose:
67
runs-on: ubuntu-latest
@@ -12,5 +13,7 @@ jobs:
1213
uses: errata-ai/[email protected]
1314
with:
1415
files: __onlyModified
16+
styles: https://github.com/rolfedh/studious-fortnight/releases/latest/download/RedHat.zip
17+
config: https://raw.githubusercontent.com/rolfedh/studious-fortnight/master/.vale-for-github-action.ini
1518
env:
1619
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.vale-for-github-action.ini

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Vale configuration file for `studious-fortnight` repository.
2+
# See: https://docs.errata.ai/vale/config
3+
4+
# Core settings appear at the top (the "global" section).
5+
6+
# The relative path to the folder containing linting rules (styles).
7+
StylesPath = .github/styles/
8+
9+
# Vocab define the exceptions to use in *all* `BasedOnStyles`.
10+
# accept.txt triggers `Vale.Terms`
11+
# reject.txt triggers `Vale.Avoid`
12+
# See: https://docs.errata.ai/vale/vocab
13+
; Vocab = RedHat
14+
15+
# Minimum alert level
16+
# -------------------
17+
# The minimum alert level in the output (suggestion, warning, or error).
18+
# If integrated into CI, builds fail by default on error-level alerts, unless you run Vale with the --no-exit flag
19+
MinAlertLevel = suggestion
20+
21+
# IgnoredScopes specifies inline-level HTML tags to ignore.
22+
# These tags may occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still won't raise any alerts.
23+
# Default: ignore `code` and `tt`.
24+
IgnoredScopes = code, tt, img, url, a, body.id
25+
# SkippedScopes specifies block-level HTML tags to ignore. Ignore any content in these scopes.
26+
# Default: ignore `script`, `style`, `pre`, and `figure`.
27+
# For AsciiDoc: by default, listingblock, and literalblock.
28+
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
29+
30+
[formats]
31+
# Associate `*.properties` files with the `md` format
32+
properties = md
33+
34+
# Match AsciiDoc files. See: https://docs.errata.ai/vale/scoping
35+
[*.adoc]
36+
# Styles to load, located in the `StylesPath` folder:
37+
BasedOnStyles = RedHat
38+
39+
; Altering rules severity (error, warning, suggestion)
40+
; RedHat.Annotations = suggestion
41+
; RedHat.Slash = warning
42+
; RedHat.Usage = suggestion
43+
44+
; Ignore attributes definition, id statements
45+
TokenIgnores = (:[^\n]+: [^\n]+), (\[id=[^\n]+)
46+
47+
# Match Markdown files. See: https://docs.errata.ai/vale/scoping
48+
# Match also `*.properties` files (see the `format` section).
49+
[*.md]
50+
# Styles to load, located in the `StylesPath` folder:
51+
BasedOnStyles = RedHat
52+
53+
# Disabling rules (NO)
54+
RedHat.HeadingPunctuation = NO
55+
RedHat.Headings = NO
56+
57+
# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
58+
TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
59+
60+
# Match INI files. See: https://docs.errata.ai/vale/scoping
61+
[*.ini]
62+
# Styles to load, located in the `StylesPath` folder:
63+
BasedOnStyles = RedHat
64+
65+
# Disabling rules (NO)
66+
RedHat.Definitions = NO
67+
RedHat.Slash = NO
68+
RedHat.Spacing = NO
69+
RedHat.Spelling = NO
70+
RedHat.url = NO
71+
RedHat.yaml = NO

.vale.ini

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# Vale configuration file for `che-docs` repository.
1+
# Vale configuration file for `studious-fortnight` repository.
22
# See: https://docs.errata.ai/vale/config
33

4+
# Core settings appear at the top (the "global" section).
5+
46
# The relative path to the folder containing linting rules (styles).
5-
StylesPath = .vale/styles/Red-Hat-CCS
7+
StylesPath = .vale/styles/
68

79
# Vocab define the exceptions to use in *all* `BasedOnStyles`.
810
# accept.txt triggers `Vale.Terms`
911
# reject.txt triggers `Vale.Avoid`
1012
# See: https://docs.errata.ai/vale/vocab
11-
Vocab = RedHat
13+
; Vocab = RedHat
1214

1315
# Minimum alert level
1416
# -------------------
@@ -25,44 +27,45 @@ IgnoredScopes = code, tt, img, url, a, body.id
2527
# For AsciiDoc: by default, listingblock, and literalblock.
2628
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
2729

28-
# Rules for matching file types. See: https://docs.errata.ai/vale/scoping
29-
[*.adoc]
30+
[formats]
31+
# Associate `*.properties` files with the `md` format
32+
properties = md
3033

34+
# Match AsciiDoc files. See: https://docs.errata.ai/vale/scoping
35+
[*.adoc]
3136
# Styles to load, located in the `StylesPath` folder:
32-
# Project specific (CheDocs)
33-
# IBM Style Guide (IBM)
34-
# Generic (Vale)
35-
BasedOnStyles = CheDocs,IBM,IBMQuickReference,SupplementaryStyleGuide,Vale
37+
BasedOnStyles = RedHat
3638

37-
# Enabling rules (YES)
38-
Vale.Spelling = YES
39+
; Altering rules severity (error, warning, suggestion)
40+
; RedHat.Annotations = suggestion
41+
; RedHat.Slash = warning
42+
; RedHat.Usage = suggestion
3943

40-
# Disabling rules (NO)
41-
Vale.Repetition = NO
42-
43-
# Altering rules severity (error, warning, suggestion)
44-
IBM.Annotations = suggestion
45-
IBM.Slash = warning
46-
IBM.Usage = suggestion
47-
48-
# Ignore attributes definition, id statements
44+
; Ignore attributes definition, id statements
4945
TokenIgnores = (:[^\n]+: [^\n]+), (\[id=[^\n]+)
5046

51-
# To validate the `che.properties` file, associate it with the `md` format
52-
[formats]
53-
properties = md
54-
55-
# Define specific rules for the `md` format, hijacked to process `che.properties`.
47+
# Match Markdown files. See: https://docs.errata.ai/vale/scoping
48+
# Match also `*.properties` files (see the `format` section).
5649
[*.md]
57-
BasedOnStyles = CheDocs,IBM,Vale
50+
# Styles to load, located in the `StylesPath` folder:
51+
BasedOnStyles = RedHat
52+
53+
# Disabling rules (NO)
54+
RedHat.HeadingPunctuation = NO
55+
RedHat.Headings = NO
56+
5857
# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
5958
TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
60-
IBM.HeadingPunctuation = NO
61-
IBM.Headings = NO
6259

60+
# Match INI files. See: https://docs.errata.ai/vale/scoping
6361
[*.ini]
64-
BasedOnStyles = CheDocs,IBM,Vale
65-
IBM.Slash = NO
66-
IBM.Spacing = NO
67-
Vale.Spelling = NO
68-
Vale.Terms = NO
62+
# Styles to load, located in the `StylesPath` folder:
63+
BasedOnStyles = RedHat
64+
65+
# Disabling rules (NO)
66+
RedHat.Definitions = NO
67+
RedHat.Slash = NO
68+
RedHat.Spacing = NO
69+
RedHat.Spelling = NO
70+
RedHat.url = NO
71+
RedHat.yaml = NO

.vale/fixtures/CheDocs/Attributes/.vale.ini

Lines changed: 0 additions & 10 deletions
This file was deleted.

.vale/fixtures/CheDocs/Attributes/invalid.testadoc

Lines changed: 0 additions & 28 deletions
This file was deleted.

.vale/fixtures/CheDocs/Attributes/valid.testadoc

Lines changed: 0 additions & 20 deletions
This file was deleted.

.vale/fixtures/CheDocs/CommonTerms/testinvalid.adoc

Lines changed: 0 additions & 3 deletions
This file was deleted.

.vale/fixtures/CheDocs/CommonTerms/testvalid.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)