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 and other improvements #630

Merged
merged 9 commits into from
Sep 27, 2024

fix callout switcheroo

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

docs: pod overrides and other improvements #630

fix callout switcheroo
54215b5
Select commit
Loading
Failed to load commit list.
GitHub Actions / LanguageTool completed Sep 27, 2024 in 1s

reviewdog [LanguageTool] report

reported by reviewdog 🐶

Findings (2)

docs/modules/druid/pages/getting_started/installation.adoc|6 col 112| 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
docs/modules/druid/pages/usage-guide/resources-and-storage.adoc|82 col 6| A comma may be missing after the conjunctive/linking adverb ‘addition’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[2])
Suggestions: addition,
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=2
Category: PUNCTUATION

Filtered Findings (24)

.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
CHANGELOG.md|218 col 93| In American English, abbreviations like “etc.” require a period. (ETC_PERIOD[1])
Suggestions: etc.
URL: https://languagetool.org/insights/post/spelling-etc-or-ect/
Rule: https://community.languagetool.org/rule/show/ETC_PERIOD?lang=en-US&subId=1
Category: AMERICAN_ENGLISH_STYLE
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/druid/pages/getting_started/first_steps.adoc|175 col 1| In American English, “take a look” is more commonly used. (HAVE_A_LOOK[5])
Suggestions: Take a look
Rule: https://community.languagetool.org/rule/show/HAVE_A_LOOK?lang=en-US&subId=5
Category: BRITISH_ENGLISH
docs/modules/druid/pages/index.adoc|4 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/druid/pages/index.adoc|14 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/druid/pages/index.adoc|62 col 1| In American English, “take a look” is more commonly used. (HAVE_A_LOOK[5])
Suggestions: Take a look
Rule: https://community.languagetool.org/rule/show/HAVE_A_LOOK?lang=en-US&subId=5
Category: BRITISH_ENGLISH
docs/modules/druid/pages/index.adoc|71 col 76| In American English, “take a look” is more commonly used. (HAVE_A_LOOK[5])
Suggestions: Take a look
Rule: https://community.languagetool.org/rule/show/HAVE_A_LOOK?lang=en-US&subId=5
Category: BRITISH_ENGLISH
docs/modules/druid/pages/index.adoc|72 col 65| In American English, “take a look” is more commonly used. (HAVE_A_LOOK[5])
Suggestions: take a look
Rule: https://community.languagetool.org/rule/show/HAVE_A_LOOK?lang=en-US&subId=5
Category: BRITISH_ENGLISH
docs/modules/druid/pages/index.adoc|99 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/druid/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/druid/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/druid/pages/usage-guide/configuration-and-environment-overrides.adoc|92 col 1| Consider replacing this phrase with the adverb “similarly” to avoid wordiness. (IN_A_X_MANNER[2])
Suggestions: Similarly
Rule: https://community.languagetool.org/rule/show/IN_A_X_MANNER?lang=en-US&subId=2
Category: REDUNDANCY
docs/modules/druid/pages/usage-guide/ingestion.adoc|6 col 69| Consider using “there are other” or “there are also” (ALSO_OTHER[1])
Suggestions: there are other, there are also
URL: https://languagetool.org/insights/post/wordiness/
Rule: https://community.languagetool.org/rule/show/ALSO_OTHER?lang=en-US&subId=1
Category: REDUNDANCY
docs/modules/druid/pages/usage-guide/security.adoc|62 col 25| 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
examples/psql-s3/README.md|10 col 15| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Username, username
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
examples/psql-s3/README.md|11 col 15| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Password, password
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
examples/psql-s3/README.md|12 col 15| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Database, database
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
examples/psql/README.md|10 col 15| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Username, username
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
examples/psql/README.md|11 col 15| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Password, password
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
examples/psql/README.md|12 col 15| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Database, database
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
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 6 in docs/modules/druid/pages/getting_started/installation.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/druid/pages/getting_started/installation.adoc#L6

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/druid/pages/getting_started/installation.adoc:6:112: 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

Check notice on line 82 in docs/modules/druid/pages/usage-guide/resources-and-storage.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/druid/pages/usage-guide/resources-and-storage.adoc#L82

A comma may be missing after the conjunctive/linking adverb ‘addition’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[2])
Suggestions: `addition,`
URL: https://languagetool.org/insights/post/linking-words/ 
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=2
Category: PUNCTUATION
Raw output
docs/modules/druid/pages/usage-guide/resources-and-storage.adoc:82:6: A comma may be missing after the conjunctive/linking adverb ‘addition’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[2])
 Suggestions: `addition,`
 URL: https://languagetool.org/insights/post/linking-words/ 
 Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=2
 Category: PUNCTUATION