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: remove home module from refs (stackabletech/documentation#637) #482

Merged
merged 1 commit into from
Aug 1, 2024

docs: remove home module from refs (stackabletech/documentation#637)

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

docs: remove home module from refs (stackabletech/documentation#637) #482

docs: remove home module from refs (stackabletech/documentation#637)
6b04f83
Select commit
Loading
Failed to load commit list.
GitHub Actions / LanguageTool completed Aug 1, 2024 in 0s

reviewdog [LanguageTool] report

reported by reviewdog 🐶

Findings (1)

docs/modules/airflow/pages/usage-guide/security.adoc|15 col 125| 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

Filtered Findings (31)

.github/pull_request_template.md|16 col 36| This expression is normally spelled as one or with a hyphen. (EN_COMPOUNDS)
Suggestions: non-trivial, nontrivial
URL: https://languagetool.org/insights/post/hyphen/
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS?lang=en-US
Category: MISC
CHANGELOG.md|20 col 540| Make sure that ‘anymore’ is used as an adverb, not as an adjective. Did you mean “any more”? (ANYMORE_ADVERB[1])
Suggestions: any more
URL: https://www.grammarphobia.com/blog/2011/04/anymore-3.html
Rule: https://community.languagetool.org/rule/show/ANYMORE_ADVERB?lang=en-US&subId=1
Category: GRAMMAR
README.md|62 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/airflow/pages/getting_started/first_steps.adoc|3 col 155| Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Suggestions: an
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/airflow/pages/getting_started/first_steps.adoc|3 col 195| 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/airflow/pages/getting_started/first_steps.adoc|80 col 40| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 16 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/getting_started/first_steps.adoc|81 col 40| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 16 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/getting_started/first_steps.adoc|82 col 40| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 16 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/getting_started/first_steps.adoc|83 col 40| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 11 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/getting_started/first_steps.adoc|84 col 40| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 11 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/getting_started/first_steps.adoc|85 col 40| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 11 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/applying-custom-resources.adoc|48 col 10| The modal verb ‘will’ requires the verb’s base form. (MD_BASEFORM[3])
Suggestions: call
Rule: https://community.languagetool.org/rule/show/MD_BASEFORM?lang=en-US&subId=3
Category: GRAMMAR
docs/modules/airflow/pages/usage-guide/applying-custom-resources.adoc|67 col 96| Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[4])
Suggestions: , and
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=4
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/mounting-dags.adoc|46 col 200| 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/airflow/pages/usage-guide/operations/graceful-shutdown.adoc|18 col 85| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: SIGTERM
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc|19 col 95| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: SIGTERM
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc|29 col 85| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: SIGTERM
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc|30 col 95| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: SIGTERM
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc|31 col 96| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: SIGTERM
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
docs/modules/airflow/pages/usage-guide/operations/graceful-shutdown.adoc|54 col 153| 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
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=3
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/overrides.adoc|13 col 133| Did you mean “effect”? ‘Affect’ is not commonly used as a noun, unless you are referring to characteristics of an emotional state. (AFFECTS[1])
Suggestions: effect
URL: https://languagetool.org/insights/post/word-choice-affect-or-effect/
Rule: https://community.languagetool.org/rule/show/AFFECTS?lang=en-US&subId=1
Category: GRAMMAR
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|7 col 3| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 3500 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|8 col 3| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 8600 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|20 col 15| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 100 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|21 col 15| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 400 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|28 col 15| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 200 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|29 col 15| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 800 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|36 col 15| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 100 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/pages/usage-guide/storage-resources.adoc|37 col 15| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 400 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
docs/modules/airflow/partials/hardware-requirements.adoc|2 col 2| Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 256 MB
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION
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/grammar-what-are-compound-sentences/
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION

Annotations

Check notice on line 15 in docs/modules/airflow/pages/usage-guide/security.adoc

See this annotation in the file changed.

@github-actions github-actions / LanguageTool

[LanguageTool] docs/modules/airflow/pages/usage-guide/security.adoc#L15

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
Raw output
docs/modules/airflow/pages/usage-guide/security.adoc:15:125: 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