Skip to content

Add "how to write dev services" documentation #5240

Add "how to write dev services" documentation

Add "how to write dev services" documentation #5240

Triggered via pull request August 28, 2024 09:58
Status Success
Total duration 1m 39s
Artifacts

vale.yml

on: pull_request
Linting with Vale
1m 28s
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.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/getting-started.adoc#L492
[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/getting-started.adoc", "range": {"start": {"line": 492, "column": 4}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/getting-started.adoc#L492
[vale] reported by reviewdog 🐶 [Quarkus.Fluff] Depending on the context, consider using 'using more direct instructions' rather than 'recommend'. Raw Output: {"message": "[Quarkus.Fluff] Depending on the context, consider using 'using more direct instructions' rather than 'recommend'.", "location": {"path": "docs/src/main/asciidoc/getting-started.adoc", "range": {"start": {"line": 492, "column": 52}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/getting-started.adoc#L495
[vale] reported by reviewdog 🐶 [Quarkus.Fluff] Depending on the context, consider using 'using more direct instructions' rather than 'recommend'. Raw Output: {"message": "[Quarkus.Fluff] Depending on the context, consider using 'using more direct instructions' rather than 'recommend'.", "location": {"path": "docs/src/main/asciidoc/getting-started.adoc", "range": {"start": {"line": 495, "column": 152}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/observability-devservices.adoc#L13
[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/observability-devservices.adoc", "range": {"start": {"line": 13, "column": 1}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/observability-devservices.adoc#L13
[vale] reported by reviewdog 🐶 [Quarkus.TermsWarnings] Consider using 'for example' rather than 'e.g.' unless updating existing content that uses the term. Raw Output: {"message": "[Quarkus.TermsWarnings] Consider using 'for example' rather than 'e.g.' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/observability-devservices.adoc", "range": {"start": {"line": 13, "column": 212}}}, "severity": "WARNING"}
Linting with Vale: docs/src/main/asciidoc/observability-devservices.adoc#L13
[vale] reported by reviewdog 🐶 [Quarkus.Spelling] Use correct American English spelling. Did you really mean 'timeseries'? Raw Output: {"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'timeseries'?", "location": {"path": "docs/src/main/asciidoc/observability-devservices.adoc", "range": {"start": {"line": 13, "column": 298}}}, "severity": "WARNING"}
Linting with Vale: docs/src/main/asciidoc/observability-devservices.adoc#L13
[vale] reported by reviewdog 🐶 [Quarkus.Spelling] Use correct American English spelling. Did you really mean 'timeseries'? Raw Output: {"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'timeseries'?", "location": {"path": "docs/src/main/asciidoc/observability-devservices.adoc", "range": {"start": {"line": 13, "column": 354}}}, "severity": "WARNING"}
Linting with Vale: docs/src/main/asciidoc/observability-devservices.adoc#L15
[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/observability-devservices.adoc", "range": {"start": {"line": 15, "column": 148}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/opentelemetry-metrics.adoc#L154
[vale] reported by reviewdog 🐶 [Quarkus.Headings] Use sentence-style capitalization in 'Grafana-OTel-LGTM Dev Service'. Raw Output: {"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Grafana-OTel-LGTM Dev Service'.", "location": {"path": "docs/src/main/asciidoc/opentelemetry-metrics.adoc", "range": {"start": {"line": 154, "column": 13}}}, "severity": "INFO"}
Linting with Vale: docs/src/main/asciidoc/infinispan-dev-services.adoc#L111
[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/infinispan-dev-services.adoc", "range": {"start": {"line": 111, "column": 31}}}, "severity": "INFO"}