Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: pod overrides, better install instructions, improved wording #569

Merged
merged 6 commits into from
Sep 27, 2024

~

1c7a428
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

docs: pod overrides, better install instructions, improved wording #569

~
1c7a428
Select commit
Loading
Failed to load commit list.
GitHub Actions / LanguageTool completed Sep 24, 2024 in 1s

reviewdog [LanguageTool] report

reported by reviewdog 🐶

Findings (2)

docs/modules/hbase/pages/getting_started/first_steps.adoc|5 col 185| In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
Suggestions: Afterward
Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
Category: BRITISH_ENGLISH
docs/modules/hbase/pages/getting_started/installation.adoc|8 col 62| Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[3])
Suggestions: , but
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=3
Category: PUNCTUATION

Filtered Findings (20)

.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md|4 col 45| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md|4 col 45| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
.github/pull_request_template.md|16 col 36| This expression is normally spelled as one or with a hyphen. (EN_COMPOUNDS_NON_TRIVIAL)
Suggestions: non-trivial, nontrivial
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_NON_TRIVIAL?lang=en-US
Category: MISC
README.md|65 col 19| It appears that hyphens are missing in the adjective “up-to-date”. (UP_TO_DATE_HYPHEN[2])
Suggestions: up-to-date
URL: https://languagetool.org/insights/post/hyphen/#hyphenated-phrases-with-more-than-one-hyphen
Rule: https://community.languagetool.org/rule/show/UP_TO_DATE_HYPHEN?lang=en-US&subId=2
Category: COMPOUNDING
docs/modules/hbase/pages/index.adoc|5 col 1| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
docs/modules/hbase/pages/index.adoc|11 col 3| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
docs/modules/hbase/pages/index.adoc|65 col 7| The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
docs/modules/hbase/pages/reference/discovery.adoc|44 col 194| Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION
docs/modules/hbase/pages/reference/discovery.adoc|44 col 213| Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION
docs/modules/hbase/pages/reference/environment-variables.adoc|27 col 86| Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION
docs/modules/hbase/pages/reference/environment-variables.adoc|56 col 82| Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION
docs/modules/hbase/pages/usage-guide/adls.adoc|20 col 6| File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: XML
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING
docs/modules/hbase/pages/usage-guide/adls.adoc|37 col 6| File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: XML
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING
docs/modules/hbase/pages/usage-guide/operations/graceful-shutdown.adoc|26 col 105| Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION
docs/modules/hbase/pages/usage-guide/operations/pod-placement.adoc|12 col 56| Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[1])
Suggestions: , so
URL: https://languagetool.org/insights/post/comma-before-and/
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/hbase/pages/usage-guide/security.adoc|52 col 8| Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
Suggestions: a
URL: https://languagetool.org/insights/post/indefinite-articles/
Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
Category: MISC
docs/modules/hbase/pages/usage-guide/security.adoc|157 col 62| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Resource, resource
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/hbase/pages/usage-guide/security.adoc|158 col 54| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Action, action
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/hbase/pages/usage-guide/security.adoc|194 col 16| Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: groups
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
tests/README-templating.md|63 col 101| Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
Suggestions: , and
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION

Annotations

Check notice on line 5 in docs/modules/hbase/pages/getting_started/first_steps.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/hbase/pages/getting_started/first_steps.adoc#L5

In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
Suggestions: `Afterward`
Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
Category: BRITISH_ENGLISH
Raw output
docs/modules/hbase/pages/getting_started/first_steps.adoc:5:185: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects. (AFTERWARDS_US[1])
 Suggestions: `Afterward`
 Rule: https://community.languagetool.org/rule/show/AFTERWARDS_US?lang=en-US&subId=1
 Category: BRITISH_ENGLISH

Check notice on line 8 in docs/modules/hbase/pages/getting_started/installation.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/hbase/pages/getting_started/installation.adoc#L8

Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[3])
Suggestions: `, but`
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence 
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=3
Category: PUNCTUATION
Raw output
docs/modules/hbase/pages/getting_started/installation.adoc:8:62: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[3])
 Suggestions: `, but`
 URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence 
 Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=3
 Category: PUNCTUATION