FAQ (frequently asked questions) documentation for extensions #5505
Annotations
10 errors and 10 warnings
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L19
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 19, "column": 15}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L35
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 35, "column": 13}}}, "severity": "ERROR"}
|
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.community/t5/GitHub-Actions/Maximum-number-of-annotations-that-can-be-created-using-GitHub/m-p/39085
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L42
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 42, "column": 5}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L42
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 42, "column": 31}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L46
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 46, "column": 5}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L57
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 57, "column": 89}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L59
[vale] reported by reviewdog 🐶
[Quarkus.RepeatedWords] 'out' is repeated!
Raw Output:
{"message": "[Quarkus.RepeatedWords] 'out' is repeated!", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 59, "column": 66}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L63
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 63, "column": 13}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L69
[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'I'.
Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'I'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 69, "column": 9}}}, "severity": "ERROR"}
|
Linting with Vale:
docs/src/main/asciidoc/writing-extensions.adoc#L17
[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/writing-extensions.adoc", "range": {"start": {"line": 17, "column": 1}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/writing-extensions.adoc#L18
[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/writing-extensions.adoc", "range": {"start": {"line": 18, "column": 7}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/writing-extensions.adoc#L18
[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'and so on' rather than 'etc' unless updating existing content that uses the term.
Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'and so on' rather than 'etc' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/writing-extensions.adoc", "range": {"start": {"line": 18, "column": 22}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L17
[vale] reported by reviewdog 🐶
[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.
Raw Output:
{"message": "[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 17, "column": 32}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L19
[vale] reported by reviewdog 🐶
[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.
Raw Output:
{"message": "[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 19, "column": 42}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L24
[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'examine' rather than 'look at' unless updating existing content that uses the term.
Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'examine' rather than 'look at' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 24, "column": 8}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L26
[vale] reported by reviewdog 🐶
[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.
Raw Output:
{"message": "[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 26, "column": 48}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L35
[vale] reported by reviewdog 🐶
[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.
Raw Output:
{"message": "[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 35, "column": 56}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L40
[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'CDI'.
Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'CDI'.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 40, "column": 4}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/extension-faq.adoc#L42
[vale] reported by reviewdog 🐶
[Quarkus.Ellipses] Avoid the ellipsis (...) except to indicate omitted words. Insert a space before and after an ellipsis.
Raw Output:
{"message": "[Quarkus.Ellipses] Avoid the ellipsis (...) except to indicate omitted words. Insert a space before and after an ellipsis.", "location": {"path": "docs/src/main/asciidoc/extension-faq.adoc", "range": {"start": {"line": 42, "column": 1}}}, "severity": "INFO"}
|