Add Vale for content linting to the repo #2135
Annotations
4 errors and 10 warnings
|
lint-prose
reviewdog: Too many results (annotations) in diff.
You may miss some annotations due to GitHub limitation for annotation created by logging command.
Please check GitHub Actions log console to see all results.
Limitation:
- 10 warning annotations and 10 error annotations per step
- 50 annotations per job (sum of annotations from all the steps)
- 50 annotations per run (separate from the job annotations, these annotations aren't created by users)
Source: https://github.community/t5/GitHub-Actions/Maximum-number-of-annotations-that-can-be-created-using-GitHub/m-p/39085
|
|
lint-prose:
docs/pages/community.md#L8
[vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There are'.
Raw Output:
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "docs/pages/community.md", "range": {"start": {"line": 8, "column": 1}}}, "severity": "ERROR"}
|
|
lint-prose:
docs/pages/libraries/jupyter-notebooks.md#L29
[vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There is'.
Raw Output:
{"message": "[write-good.ThereIs] Don't start a sentence with 'There is'.", "location": {"path": "docs/pages/libraries/jupyter-notebooks.md", "range": {"start": {"line": 29, "column": 1}}}, "severity": "ERROR"}
|
|
lint-prose
Vale and reviewdog exited with status code: 1
|
|
lint-prose:
docs/pages/benchmarking-profiling.md#L10
[vale] reported by reviewdog 🐶
[RedHat.ProductCentricWriting] Do not use transitive verb constructions like 'Allows you' to grant abilities to inanimate objects. Whenever possible, use direct, user-focused sentences where the subject of the sentence performs the action.
Raw Output:
{"message": "[RedHat.ProductCentricWriting] Do not use transitive verb constructions like 'Allows you' to grant abilities to inanimate objects. Whenever possible, use direct, user-focused sentences where the subject of the sentence performs the action.", "location": {"path": "docs/pages/benchmarking-profiling.md", "range": {"start": {"line": 10, "column": 111}}}, "severity": "INFO"}
|
|
lint-prose:
docs/pages/benchmarking-profiling.md#L33
[vale] reported by reviewdog 🐶
[RedHat.SmartQuotes] Do not use smart quotation marks. Use ''' rather than ’.
Raw Output:
{"message": "[RedHat.SmartQuotes] Do not use smart quotation marks. Use ''' rather than ’.", "location": {"path": "docs/pages/benchmarking-profiling.md", "range": {"start": {"line": 33, "column": 111}}}, "severity": "WARNING"}
|
|
lint-prose:
docs/index.md#L7
[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'tool' or 'tools' rather than 'tooling' unless updating existing content that uses the term.
Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'tool' or 'tools' rather than 'tooling' unless updating existing content that uses the term.", "location": {"path": "docs/index.md", "range": {"start": {"line": 7, "column": 28}}}, "severity": "WARNING"}
|
|
lint-prose:
docs/index.md#L12
[vale] reported by reviewdog 🐶
[RedHat.SimpleWords] Use simple language. Consider using 'has' rather than 'contains'.
Raw Output:
{"message": "[RedHat.SimpleWords] Use simple language. Consider using 'has' rather than 'contains'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 12, "column": 61}}}, "severity": "INFO"}
|
|
lint-prose:
docs/index.md#L18
[vale] reported by reviewdog 🐶
[RedHat.Symbols] Do not use the '!' symbol.
Raw Output:
{"message": "[RedHat.Symbols] Do not use the '!' symbol.", "location": {"path": "docs/index.md", "range": {"start": {"line": 18, "column": 20}}}, "severity": "INFO"}
|
|
lint-prose:
docs/index.md#L28
[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'tool' or 'tools' rather than 'tooling' unless updating existing content that uses the term.
Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'tool' or 'tools' rather than 'tooling' unless updating existing content that uses the term.", "location": {"path": "docs/index.md", "range": {"start": {"line": 28, "column": 56}}}, "severity": "WARNING"}
|
|
lint-prose:
docs/index.md#L47
[vale] reported by reviewdog 🐶
[RedHat.Contractions] Avoid contractions. Use ''do not'' rather than 'don't.'
Raw Output:
{"message": "[RedHat.Contractions] Avoid contractions. Use ''do not'' rather than 'don't.'", "location": {"path": "docs/index.md", "range": {"start": {"line": 47, "column": 52}}}, "severity": "INFO"}
|
|
lint-prose:
docs/index.md#L47
[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'might' or 'can' rather than 'may' unless updating existing content that uses the term.
Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'might' or 'can' rather than 'may' unless updating existing content that uses the term.", "location": {"path": "docs/index.md", "range": {"start": {"line": 47, "column": 88}}}, "severity": "WARNING"}
|
|
lint-prose:
docs/index.md#L48
[vale] reported by reviewdog 🐶
[RedHat.Contractions] Avoid contractions. Use ''it is'' rather than 'it's.'
Raw Output:
{"message": "[RedHat.Contractions] Avoid contractions. Use ''it is'' rather than 'it's.'", "location": {"path": "docs/index.md", "range": {"start": {"line": 48, "column": 104}}}, "severity": "INFO"}
|
|
lint-prose:
docs/index.md#L50
[vale] reported by reviewdog 🐶
[RedHat.SimpleWords] Use simple language. Consider using 'choices' or 'options' rather than 'alternatives'.
Raw Output:
{"message": "[RedHat.SimpleWords] Use simple language. Consider using 'choices' or 'options' rather than 'alternatives'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 50, "column": 3}}}, "severity": "INFO"}
|