Overhaul concept docs #3087
Overhaul concept docs #3087
reviewdog [vale] report
reported by reviewdog 🐶
Findings (50)
docs/content/concepts/cache.md|17 col 26| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/concepts/selector.md|25 col 20| [RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
docs/content/concepts/advanced/auto-scale.md|85 col 69| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/concepts/advanced/auto-scale.md|115 col 36| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/concepts/advanced/auto-scale.md|132 col 7| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/aperture-for-infra/agent/kubernetes/operator/daemonset.md|103 col 14| [RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
docs/content/aperture-for-infra/agent/kubernetes/operator/sidecar.md|299 col 26| [RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
docs/content/reference/configuration/agent.md|882 col 42| [RedHat.Hyphens] Use 'preprocessor' rather than 'pre-processor'.
docs/content/reference/aperture-cli/aperturectl/completion/fish/fish.md|23 col 44| [RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md|20 col 23| [RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md|28 col 44| [RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
docs/content/reference/aperture-cli/aperturectl/completion/bash/bash.md|26 col 44| [RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
docs/content/reference/cloud-ui/api-keys.md|30 col 34| [RedHat.TermsWarnings] Consider using 'click' rather than 'click on' unless updating existing content that uses the term.
docs/content/reference/cloud-ui/policies/policy-creation.md|28 col 70| [RedHat.TermsWarnings] Consider using 'click' rather than 'Click on' unless updating existing content that uses the term.
docs/content/sdk/python/manual.md|32 col 45| [RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
docs/content/sdk/go/manual.md|126 col 20| [RedHat.TermsWarnings] Consider using 'might' or 'can' rather than 'may' unless updating existing content that uses the term.
docs/content/guides/per-user-rate-limiting.md|109 col 23| [RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
docs/content/guides/api-quota-management.md|116 col 9| [RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
docs/content/sdk/java/springboot.md|74 col 35| [RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
docs/content/sdk/java/armeria.md|53 col 7| [RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
docs/content/sdk/java/tomcat.md|58 col 35| [RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
docs/content/sdk/java/netty.md|59 col 7| [RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
docs/content/guides/openai.md|219 col 47| [RedHat.TermsWarnings] Consider using 'click' rather than 'click on' unless updating existing content that uses the term.
docs/content/guides/openai.md|354 col 8| [RedHat.TermsWarnings] Consider using 'lower right' rather than 'bottom right' unless updating existing content that uses the term.
docs/content/get-started/get-started.md|28 col 1| [RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
docs/content/get-started/get-started.md|47 col 36| [RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
docs/content/get-started/get-started.md|167 col 57| [RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
docs/content/get-started/get-started.md|203 col 1| [RedHat.TermsWarnings] Consider using 'click' rather than 'click on' unless updating existing content that uses the term.
docs/content/get-started/get-started.md|229 col 53| [RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
docs/content/get-started/get-started.md|251 col 36| [RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
docs/content/reference/configuration/spec.md|198 col 1| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'Desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|473 col 1| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'Desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|473 col 41| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|733 col 1| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'Desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|733 col 41| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|1045 col 7| [RedHat.Hyphens] Use 'nonzero' rather than 'non-zero'.
docs/content/reference/configuration/spec.md|1720 col 62| [RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|4222 col 17| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|4224 col 43| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|4388 col 10| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|4577 col 5| [RedHat.Hyphens] Use 'nonzero' rather than 'non-zero'.
docs/content/reference/configuration/spec.md|5011 col 69| [RedHat.Hyphens] Use 'nonzero' rather than 'non-zero'.
docs/content/reference/configuration/spec.md|6418 col 46| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|6505 col 5| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|6656 col 41| [RedHat.TermsWarnings] Consider using 'and' rather than 'as well as' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|6849 col 33| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|7597 col 1| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'Desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|7597 col 41| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|8898 col 25| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
docs/content/reference/configuration/spec.md|9140 col 24| [RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
Filtered Findings (0)
Annotations
Check warning on line 17 in docs/content/concepts/cache.md
github-actions / vale
[vale] docs/content/concepts/cache.md#L17
[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.", "location": {"path": "docs/content/concepts/cache.md", "range": {"start": {"line": 17, "column": 26}}}, "severity": "WARNING"}
Check warning on line 25 in docs/content/concepts/selector.md
github-actions / vale
[vale] docs/content/concepts/selector.md#L25
[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "docs/content/concepts/selector.md", "range": {"start": {"line": 25, "column": 20}}}, "severity": "WARNING"}
Check warning on line 85 in docs/content/concepts/advanced/auto-scale.md
github-actions / vale
[vale] docs/content/concepts/advanced/auto-scale.md#L85
[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.", "location": {"path": "docs/content/concepts/advanced/auto-scale.md", "range": {"start": {"line": 85, "column": 69}}}, "severity": "WARNING"}
Check warning on line 115 in docs/content/concepts/advanced/auto-scale.md
github-actions / vale
[vale] docs/content/concepts/advanced/auto-scale.md#L115
[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.", "location": {"path": "docs/content/concepts/advanced/auto-scale.md", "range": {"start": {"line": 115, "column": 36}}}, "severity": "WARNING"}
Check warning on line 132 in docs/content/concepts/advanced/auto-scale.md
github-actions / vale
[vale] docs/content/concepts/advanced/auto-scale.md#L132
[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'needed' or 'required' rather than 'desired' unless updating existing content that uses the term.", "location": {"path": "docs/content/concepts/advanced/auto-scale.md", "range": {"start": {"line": 132, "column": 7}}}, "severity": "WARNING"}
Check warning on line 103 in docs/content/aperture-for-infra/agent/kubernetes/operator/daemonset.md
github-actions / vale
[vale] docs/content/aperture-for-infra/agent/kubernetes/operator/daemonset.md#L103
[RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
Raw output
{"message": "[RedHat.DoNotUseTerms] Do not use \"please\" in technical documentation.", "location": {"path": "docs/content/aperture-for-infra/agent/kubernetes/operator/daemonset.md", "range": {"start": {"line": 103, "column": 14}}}, "severity": "WARNING"}
Check warning on line 299 in docs/content/aperture-for-infra/agent/kubernetes/operator/sidecar.md
github-actions / vale
[vale] docs/content/aperture-for-infra/agent/kubernetes/operator/sidecar.md#L299
[RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
Raw output
{"message": "[RedHat.DoNotUseTerms] Do not use \"please\" in technical documentation.", "location": {"path": "docs/content/aperture-for-infra/agent/kubernetes/operator/sidecar.md", "range": {"start": {"line": 299, "column": 26}}}, "severity": "WARNING"}
Check warning on line 882 in docs/content/reference/configuration/agent.md
github-actions / vale
[vale] docs/content/reference/configuration/agent.md#L882
[RedHat.Hyphens] Use 'preprocessor' rather than 'pre-processor'.
Raw output
{"message": "[RedHat.Hyphens] Use 'preprocessor' rather than 'pre-processor'.", "location": {"path": "docs/content/reference/configuration/agent.md", "range": {"start": {"line": 882, "column": 42}}}, "severity": "WARNING"}
Check warning on line 23 in docs/content/reference/aperture-cli/aperturectl/completion/fish/fish.md
github-actions / vale
[vale] docs/content/reference/aperture-cli/aperturectl/completion/fish/fish.md#L23
[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.", "location": {"path": "docs/content/reference/aperture-cli/aperturectl/completion/fish/fish.md", "range": {"start": {"line": 23, "column": 44}}}, "severity": "WARNING"}
Check warning on line 20 in docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md
github-actions / vale
[vale] docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md#L20
[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.", "location": {"path": "docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md", "range": {"start": {"line": 20, "column": 23}}}, "severity": "WARNING"}
Check warning on line 28 in docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md
github-actions / vale
[vale] docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md#L28
[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.", "location": {"path": "docs/content/reference/aperture-cli/aperturectl/completion/zsh/zsh.md", "range": {"start": {"line": 28, "column": 44}}}, "severity": "WARNING"}
Check warning on line 26 in docs/content/reference/aperture-cli/aperturectl/completion/bash/bash.md
github-actions / vale
[vale] docs/content/reference/aperture-cli/aperturectl/completion/bash/bash.md#L26
[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.", "location": {"path": "docs/content/reference/aperture-cli/aperturectl/completion/bash/bash.md", "range": {"start": {"line": 26, "column": 44}}}, "severity": "WARNING"}
Check warning on line 30 in docs/content/reference/cloud-ui/api-keys.md
github-actions / vale
[vale] docs/content/reference/cloud-ui/api-keys.md#L30
[RedHat.TermsWarnings] Consider using 'click' rather than 'click on' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'click' rather than 'click on' unless updating existing content that uses the term.", "location": {"path": "docs/content/reference/cloud-ui/api-keys.md", "range": {"start": {"line": 30, "column": 34}}}, "severity": "WARNING"}
Check warning on line 28 in docs/content/reference/cloud-ui/policies/policy-creation.md
github-actions / vale
[vale] docs/content/reference/cloud-ui/policies/policy-creation.md#L28
[RedHat.TermsWarnings] Consider using 'click' rather than 'Click on' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'click' rather than 'Click on' unless updating existing content that uses the term.", "location": {"path": "docs/content/reference/cloud-ui/policies/policy-creation.md", "range": {"start": {"line": 28, "column": 70}}}, "severity": "WARNING"}
Check warning on line 32 in docs/content/sdk/python/manual.md
github-actions / vale
[vale] docs/content/sdk/python/manual.md#L32
[RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
Raw output
{"message": "[RedHat.DoNotUseTerms] Do not use \"please\" in technical documentation.", "location": {"path": "docs/content/sdk/python/manual.md", "range": {"start": {"line": 32, "column": 45}}}, "severity": "WARNING"}
Check warning on line 126 in docs/content/sdk/go/manual.md
github-actions / vale
[vale] docs/content/sdk/go/manual.md#L126
[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/content/sdk/go/manual.md", "range": {"start": {"line": 126, "column": 20}}}, "severity": "WARNING"}
Check warning on line 109 in docs/content/guides/per-user-rate-limiting.md
github-actions / vale
[vale] docs/content/guides/per-user-rate-limiting.md#L109
[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.", "location": {"path": "docs/content/guides/per-user-rate-limiting.md", "range": {"start": {"line": 109, "column": 23}}}, "severity": "WARNING"}
Check warning on line 116 in docs/content/guides/api-quota-management.md
github-actions / vale
[vale] docs/content/guides/api-quota-management.md#L116
[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'run', 'issue', 'start', or 'enter' rather than 'execute' unless updating existing content that uses the term.", "location": {"path": "docs/content/guides/api-quota-management.md", "range": {"start": {"line": 116, "column": 9}}}, "severity": "WARNING"}
Check warning on line 74 in docs/content/sdk/java/springboot.md
github-actions / vale
[vale] docs/content/sdk/java/springboot.md#L74
[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "docs/content/sdk/java/springboot.md", "range": {"start": {"line": 74, "column": 35}}}, "severity": "WARNING"}
Check warning on line 53 in docs/content/sdk/java/armeria.md
github-actions / vale
[vale] docs/content/sdk/java/armeria.md#L53
[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "docs/content/sdk/java/armeria.md", "range": {"start": {"line": 53, "column": 7}}}, "severity": "WARNING"}
Check warning on line 58 in docs/content/sdk/java/tomcat.md
github-actions / vale
[vale] docs/content/sdk/java/tomcat.md#L58
[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "docs/content/sdk/java/tomcat.md", "range": {"start": {"line": 58, "column": 35}}}, "severity": "WARNING"}
Check warning on line 59 in docs/content/sdk/java/netty.md
github-actions / vale
[vale] docs/content/sdk/java/netty.md#L59
[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "docs/content/sdk/java/netty.md", "range": {"start": {"line": 59, "column": 7}}}, "severity": "WARNING"}
Check warning on line 219 in docs/content/guides/openai.md
github-actions / vale
[vale] docs/content/guides/openai.md#L219
[RedHat.TermsWarnings] Consider using 'click' rather than 'click on' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'click' rather than 'click on' unless updating existing content that uses the term.", "location": {"path": "docs/content/guides/openai.md", "range": {"start": {"line": 219, "column": 47}}}, "severity": "WARNING"}
Check warning on line 354 in docs/content/guides/openai.md
github-actions / vale
[vale] docs/content/guides/openai.md#L354
[RedHat.TermsWarnings] Consider using 'lower right' rather than 'bottom right' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'lower right' rather than 'bottom right' unless updating existing content that uses the term.", "location": {"path": "docs/content/guides/openai.md", "range": {"start": {"line": 354, "column": 8}}}, "severity": "WARNING"}
Check warning on line 28 in docs/content/get-started/get-started.md
github-actions / vale
[vale] docs/content/get-started/get-started.md#L28
[RedHat.DoNotUseTerms] Do not use "please" in technical documentation.
Raw output
{"message": "[RedHat.DoNotUseTerms] Do not use \"please\" in technical documentation.", "location": {"path": "docs/content/get-started/get-started.md", "range": {"start": {"line": 28, "column": 1}}}, "severity": "WARNING"}