Skip to content

Reordered the Get started section, spit initial setup intop topics

Sign in for the full log view
GitHub Actions / vale completed Nov 8, 2023 in 2s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (64)

snippets/install-result.md|8 col 43| [Google.WordList] Use 'app' instead of 'application'.
snippets/pbm-install-nodes.md|6 col 17| [Google.Parens] Use parentheses judiciously.
docs/installation.md|1 col 3| [Google.Headings] 'Quickstart Guides' should use sentence-style capitalization.
docs/installation.md|7 col 50| [Google.We] Try to avoid using first-person plural like 'we'.
docs/installation.md|9 col 29| [Google.Colons] ': P' should be in lowercase.
docs/installation.md|18 col 20| [Google.Colons] ': D' should be in lowercase.
docs/installation.md|26 col 24| [Google.Colons] ': K' should be in lowercase.
docs/installation.md|34 col 28| [Google.Colons] ': B' should be in lowercase.
docs/installation.md|42 col 27| [Google.Colons] ': M' should be in lowercase.
docs/install/backup-storage.md|1 col 3| [Google.Headings] 'Configure remote backup storage' should use sentence-style capitalization.
docs/install/backup-storage.md|5 col 75| [Google.We] Try to avoid using first-person plural like 'We'.
docs/install/backup-storage.md|5 col 145| [Vale.Spelling] Did you really mean 'storages'?
docs/install/backup-storage.md|8 col 1| [Google.Parens] Use parentheses judiciously.
docs/install/backup-storage.md|8 col 26| [Google.Latin] Use 'for example' instead of 'e.g.'.
docs/install/backup-storage.md|12 col 58| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/install/backup-storage.md|60 col 122| [Google.Parens] Use parentheses judiciously.
docs/install/initial-setup.md|7 col 109| [Google.Contractions] Use 'that's' instead of 'that is'.
docs/install/repos.md|9 col 27| [Google.Colons] ': W' should be in lowercase.
docs/install/source.md|7 col 14| [Google.WordList] Use 'preceding' instead of 'above'.
docs/install/source.md|33 col 46| [Google.Passive] In general, use active voice instead of passive voice ('been built').
docs/install/start-pbm-agent.md|3 col 69| [Google.Contractions] Use 'it's' instead of 'It is'.
docs/install/start-pbm-agent.md|10 col 275| [Google.Latin] Use 'for example' instead of 'e.g.'.
docs/install/start-pbm-agent.md|10 col 361| [Google.Latin] Use 'for example' instead of 'e.g.'.
docs/install/start-pbm-agent.md|13 col 8| [Google.Passive] In general, use active voice instead of passive voice ('is redirected').
docs/install/start-pbm-agent.md|13 col 48| [Google.Passive] In general, use active voice instead of passive voice ('is backgrounded').
docs/install/start-pbm-agent.md|13 col 51| [Vale.Spelling] Did you really mean 'backgrounded'?
docs/install/start-pbm-agent.md|23 col 130| [Google.Will] Avoid using 'will'.
docs/install/start-pbm-agent.md|23 col 135| [Google.Passive] In general, use active voice instead of passive voice ('be written').
docs/install/start-pbm-agent.md|29 col 65| [Google.Passive] In general, use active voice instead of passive voice ('is captured').
docs/install/start-pbm-agent.md|42 col 66| [Vale.Spelling] Did you really mean 'stdout'?
docs/install/start-pbm-agent.md|42 col 77| [Vale.Spelling] Did you really mean 'stderr'?
docs/install/start-pbm-agent.md|44 col 58| [Google.Passive] In general, use active voice instead of passive voice ('is printed').
docs/install/configure-authentication.md|1 col 3| [Google.Headings] 'Configure authentication in MongoDB' should use sentence-style capitalization.
docs/install/configure-authentication.md|11 col 30| [Google.Colons] ': I' should be in lowercase.
docs/install/configure-authentication.md|42 col 142| [Google.WordList] Use 'preceding' instead of 'above'.
docs/install/configure-authentication.md|42 col 148| [Google.Passive] In general, use active voice instead of passive voice ('are granted').
docs/install/configure-authentication.md|57 col 30| [Google.Colons] ': I' should be in lowercase.
docs/install/configure-authentication.md|57 col 97| [Google.Passive] In general, use active voice instead of passive voice ('is installed').
docs/install/configure-authentication.md|61 col 1| [Google.Parens] Use parentheses judiciously.
docs/install/configure-authentication.md|61 col 104| [Vale.Spelling] Did you really mean 'systemd'?
docs/install/configure-authentication.md|63 col 25| [Vale.Spelling] Did you really mean 'systemd'?
docs/install/configure-authentication.md|114 col 302| [Google.Passive] In general, use active voice instead of passive voice ('be passed').
docs/install/configure-authentication.md|122 col 30| [Google.Colons] ': I' should be in lowercase.
docs/install/configure-authentication.md|122 col 88| [Google.Will] Avoid using 'will'.
docs/install/configure-authentication.md|136 col 16| [Google.Acronyms] Spell out 'SCRAM', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|140 col 239| [Google.Latin] Use 'for example' instead of 'e.g.'.
docs/install/configure-authentication.md|140 col 261| [Google.Acronyms] Spell out 'COM', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|154 col 45| [Google.Will] Avoid using 'will'.
docs/install/configure-authentication.md|156 col 50| [Google.Acronyms] Spell out 'LDAP', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|156 col 220| [Google.Acronyms] Spell out 'LDAP', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|156 col 256| [Google.Passive] In general, use active voice instead of passive voice ('are stored').
docs/install/configure-authentication.md|156 col 286| [Google.Acronyms] Spell out 'LDAP', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|162 col 13| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|162 col 17| [Google.Acronyms] Spell out 'IAM', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|162 col 126| [Google.Acronyms] Spell out 'ARN', if it's unfamiliar to the audience.
docs/install/configure-authentication.md|162 col 137| [Google.Acronyms] Spell out 'IAM', if it's unfamiliar to the audience.
docs/manage/overview.md|3 col 149| [Vale.Spelling] Did you really mean 'followng'?
docs/404.md|3 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
docs/index.md|20 col 4| [Google.Headings] ':material-progress-download: Installation guides { .title }' should use sentence-style capitalization.
docs/index.md|28 col 5| [Google.Headings] ':material-backup-restore: Backup management { .title }' should use sentence-style capitalization.
docs/index.md|36 col 5| [Google.Headings] ':fontawesome-solid-gears: Administration { .title }' should use sentence-style capitalization.
docs/index.md|43 col 5| [Google.Headings] ':material-frequently-asked-questions: Diagnostics and FAQ { .title }' should use sentence-style capitalization.
docs/index.md|45 col 1| [Google.We] Try to avoid using first-person plural like 'Our'.
docs/index.md|45 col 29| [Google.Will] Avoid using 'will'.

Filtered Findings (1112)

snippets/services-banner.md|7 col 109| [Google.We] Try to avoid using first-person plural like 'our'.
snippets/services-banner.md|11 col 25| [Google.Colons] ': C' should be in lowercase.
snippets/services-banner.md|11 col 151| [Google.Colons] ': G' should be in lowercase.
README.md|1 col 3| [Google.Headings] 'Percona Backup for MongoDB documentation' should use sentence-style capitalization.
README.md|4 col 39| [Google.Exclamation] Don't use exclamation points in text.
README.md|13 col 161| [Google.Passive] In general, use active voice instead of passive voice ('is written').
README.md|13 col 257| [Google.Passive] In general, use active voice instead of passive voice ('is created').
README.md|17 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
README.md|21 col 9| [Google.Passive] In general, use active voice instead of passive voice ('is dedicated').
README.md|21 col 74| [Google.We] Try to avoid using first-person plural like 'we'.
README.md|21 col 125| [Google.We] Try to avoid using first-person plural like 'our'.
README.md|21 col 175| [Google.We] Try to avoid using first-person plural like 'we'.
README.md|21 col 175| [Google.Contractions] Use 'we're' instead of 'we are'.
docs/copyright.md|5 col 45| [Google.Parens] Use parentheses judiciously.
docs/copyright.md|5 col 66| [Google.Acronyms] Spell out 'LLC', if it's unfamiliar to the audience.
docs/copyright.md|6 col 5| [Google.Passive] In general, use active voice instead of passive voice ('is distributed').
docs/reference/pitr-options.md|13 col 9| [Vale.Spelling] Did you really mean 'boolean'?
docs/reference/pitr-options.md|14 col 10| [Google.Colons] ': F' should be in lowercase.
docs/reference/pitr-options.md|18 col 5| [Google.Headings] 'pitr.oplogSpanMin' should use sentence-style capitalization.
docs/reference/pitr-options.md|23 col 114| [Google.Passive] In general, use active voice instead of passive voice ('is updated').
docs/reference/pitr-options.md|25 col 71| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
docs/reference/pitr-options.md|25 col 174| [Google.Passive] In general, use active voice instead of passive voice ('is saved').
docs/reference/pitr-options.md|36 col 5| [Google.Headings] 'pitr.compressionLevel' should use sentence-style capitalization.
docs/reference/pitr-options.md|48 col 33| [Google.Parens] Use parentheses judiciously.
docs/reference/pitr-options.md|52 col 83| [Google.Will] Avoid using 'will'.
docs/reference/pitr-options.md|54 col 5| [Google.Headings] 'pitr.oplogOnly' should use sentence-style capitalization.
docs/reference/pitr-options.md|56 col 9| [Vale.Spelling] Did you really mean 'boolean'?
docs/reference/pitr-options.md|57 col 10| [Google.Colons] ': F' should be in lowercase.
docs/reference/pitr-options.md|58 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/pitr-options.md|60 col 34| [Google.Passive] In general, use active voice instead of passive voice ('is required').
docs/reference/backup-options.md|16 col 5| [Google.Headings] 'priority' should use sentence-style capitalization.
docs/reference/backup-options.md|20 col 102| [Google.Passive] In general, use active voice instead of passive voice ('is elected').
docs/reference/backup-options.md|28 col 5| [Google.Headings] 'backup.compression' should use sentence-style capitalization.
docs/reference/backup-options.md|35 col 13| [Google.Passive] In general, use active voice instead of passive voice ('is specified').
docs/reference/backup-options.md|35 col 35| [Google.Passive] In general, use active voice instead of passive voice ('are made').
docs/reference/backup-options.md|40 col 5| [Google.Headings] 'backup.compressionLevel' should use sentence-style capitalization.
docs/reference/backup-options.md|52 col 33| [Google.Parens] Use parentheses judiciously.
docs/reference/backup-options.md|55 col 83| [Google.Will] Avoid using 'will'.
docs/reference/backup-options.md|57 col 5| [Google.Headings] 'backup.timeouts.startingStatus' should use sentence-style capitalization.
docs/reference/backup-options.md|62 col 15| [Google.Parens] Use parentheses judiciously.
docs/reference/backup-options.md|64 col 7| [Google.Parens] Use parentheses judiciously.
CONTRIBUTING.md|3 col 39| [Google.Exclamation] Don't use exclamation points in text.
CONTRIBUTING.md|5 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
CONTRIBUTING.md|15 col 42| [Google.Passive] In general, use active voice instead of passive voice ('is written').
CONTRIBUTING.md|27 col 27| [Google.WordList] Use 'select' instead of 'check'.
CONTRIBUTING.md|35 col 294| [Google.Spacing] 'e. T' should have one space.
CONTRIBUTING.md|36 col 17| [Google.We] Try to avoid using first-person plural like 'our'.
CONTRIBUTING.md|70 col 103| [Vale.Spelling] Did you really mean 'repo'?
CONTRIBUTING.md|71 col 37| [Google.Parens] Use parentheses judiciously.
CONTRIBUTING.md|71 col 52| [Vale.Spelling] Did you really mean 'VSCode'?
CONTRIBUTING.md|71 col 118| [Google.WordList] Use 'select' instead of 'check'.
CONTRIBUTING.md|71 col 137| [Google.Passive] In general, use active voice instead of passive voice ('is rendered').
CONTRIBUTING.md|72 col 128| [Google.Will] Avoid using 'will'.
CONTRIBUTING.md|78 col 96| [Google.Passive] In general, use active voice instead of passive voice ('is called').
CONTRIBUTING.md|86 col 4| [Google.We] Try to avoid using first-person plural like 'We'.
CONTRIBUTING.md|86 col 12| [Google.We] Try to avoid using first-person plural like 'our'.
CONTRIBUTING.md|127 col 6| [Google.Headings] 'PDF' should use sentence-style capitalization.
CONTRIBUTING.md|146 col 28| [Google.Passive] In general, use active voice instead of passive voice ('is merged').
CONTRIBUTING.md|148 col 24| [Google.Passive] In general, use active voice instead of passive voice ('is merged').
CONTRIBUTING.md|148 col 101| [Google.Exclamation] Don't use exclamation points in text.
CONTRIBUTING.md|159 col 35| [Vale.Spelling] Did you really mean 'favicons'?
CONTRIBUTING.md|161 col 12| [Vale.Spelling] Did you really mean 'Javascript'?
CONTRIBUTING.md|168 col 48| [Google.Passive] In general, use active voice instead of passive voice ('are put').
docs/reference/config.md|1 col 3| [Google.Headings] 'Percona Backup for MongoDB configuration in a cluster (or non-sharded replica set)' should use sentence-style capitalization.
docs/reference/config.md|1 col 57| [Google.Parens] Use parentheses judiciously.
docs/reference/config.md|3 col 31| [Google.Passive] In general, use active voice instead of passive voice ('is stored').
docs/reference/config.md|3 col 116| [Google.Passive] In general, use active voice instead of passive voice ('is shared').
docs/reference/config.md|3 col 172| [Google.Parens] Use parentheses judiciously.
docs/reference/config.md|3 col 210| [Google.Passive] In general, use active voice instead of passive voice ('be read').
docs/reference/config.md|11 col 44| [Google.Semicolons] Use semicolons judiciously.
docs/reference/config.md|11 col 75| [Vale.Spelling] Did you really mean 'subcommand'?
docs/reference/config.md|21 col 93| [Google.Parens] Use parentheses judiciously.
docs/reference/config.md|21 col 124| [Google.Will] Avoid using 'will'.
docs/reference/config.md|21 col 129| [Google.Passive] In general, use active voice instead of passive voice ('be redacted').
docs/reference/config.md|23 col 4| [Google.Headings] 'Insert the whole Percona Backup for MongoDB config from a YAML file' should use sentence-style capitalization.
docs/reference/config.md|25 col 84| [Google.Contractions] Use 'it's' instead of 'it is'.
docs/reference/config.md|28 col 61| [Google.Parens] Use parentheses judiciously.
docs/reference/config.md|30 col 74| [Google.WordList] Use 'filename' instead of 'file name'.
docs/reference/config.md|36 col 70| [Google.Contractions] Use 'it's' instead of 'it is'.
docs/reference/config.md|38 col 92| [Google.Contractions] Use 'aren't' instead of 'are not'.
docs/reference/config.md|48 col 67| [Google.Spacing] 'f. I' should have one space.
docs/reference/restore-options.md|16 col 5| [Google.Headings] 'batchSize' should use sentence-style capitalization.
docs/reference/restore-options.md|16 col 5| [Vale.Spelling] Did you really mean 'batchSize'?
docs/reference/restore-options.md|23 col 5| [Google.Headings] 'numInsertionWorkers' should use sentence-style capitalization.
docs/reference/restore-options.md|30 col 5| [Google.Headings] 'numDownloadWorkers' should use sentence-style capitalization.
docs/reference/restore-options.md|37 col 5| [Google.Headings] 'maxDownloadBufferMb' should use sentence-style capitalization.
docs/reference/restore-options.md|42 col 42| [Google.Contractions] Use 'that's' instead of 'that is'.
docs/reference/restore-options.md|42 col 47| [Google.Passive] In general, use active voice instead of passive voice ('is used').
docs/reference/restore-options.md|42 col 133| [Google.Contractions] Use 'can't' instead of 'cannot'.
docs/reference/restore-options.md|44 col 5| [Google.Headings] 'downloadChunkMb' should use sentence-style capitalization.
docs/reference/restore-options.md|51 col 5| [Vale.Spelling] Did you really mean 'mongodLocation'?
docs/reference/restore-options.md|51 col 5| [Google.Headings] 'mongodLocation' should use sentence-style capitalization.
docs/reference/restore-options.md|57 col 5| [Google.Headings] 'mongodLocationMap' should use sentence-style capitalization.
docs/reference/configuration-options.md|5 col 5| [Google.Headings] 'storage.type' should use sentence-style capitalization.
docs/reference/configuration-options.md|9 col 17| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|42 col 5| [Google.Headings] 'storage.s3.provider' should use sentence-style capitalization.
docs/reference/configuration-options.md|46 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|52 col 5| [Google.Headings] 'storage.s3.bucket' should use sentence-style capitalization.
docs/reference/configuration-options.md|56 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|56 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|58 col 42| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|58 col 163| [Google.Acronyms] Spell out 'GCS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|60 col 5| [Google.Headings] 'storage.s3.region' should use sentence-style capitalization.
docs/reference/configuration-options.md|63 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|63 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|63 col 17| [Google.Parens] Use parentheses judiciously.
docs/reference/configuration-options.md|63 col 22| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|63 col 30| [Google.Acronyms] Spell out 'GCS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|66 col 10| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|66 col 100| [Google.Acronyms] Spell out 'GCS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|68 col 5| [Google.Headings] 'storage.s3.prefix' should use sentence-style capitalization.
docs/reference/configuration-options.md|71 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|73 col 69| [Google.Passive] In general, use active voice instead of passive voice ('are stored').
docs/reference/configuration-options.md|75 col 5| [Google.Headings] 'storage.s3.endpointUrl' should use sentence-style capitalization.
docs/reference/configuration-options.md|78 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|78 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|78 col 17| [Google.Parens] Use parentheses judiciously.
docs/reference/configuration-options.md|78 col 32| [Google.Acronyms] Spell out 'GCS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|80 col 53| [Google.Acronyms] Spell out 'GCS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|82 col 5| [Google.Headings] 'storage.s3.forcePathStyle' should use sentence-style capitalization.
docs/reference/configuration-options.md|84 col 9| [Vale.Spelling] Did you really mean 'boolean'?
docs/reference/configuration-options.md|85 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|87 col 233| [Google.EnDash] Use an em dash ('—') instead of '–'.
docs/reference/configuration-options.md|89 col 5| [Google.Headings] 'storage.s3.credentials.access-key-id' should use sentence-style capitalization.
docs/reference/configuration-options.md|92 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|92 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|94 col 56| [Google.Passive] In general, use active voice instead of passive voice ('be omitted').
docs/reference/configuration-options.md|96 col 5| [Google.Headings] 'storage.s3.credentials.secret-access-key' should use sentence-style capitalization.
docs/reference/configuration-options.md|99 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|99 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|101 col 83| [Google.Passive] In general, use active voice instead of passive voice ('be omitted').
docs/reference/configuration-options.md|103 col 5| [Google.Headings] 'storage.s3.credentials.session-token' should use sentence-style capitalization.
docs/reference/configuration-options.md|106 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|108 col 5| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|110 col 5| [Google.Headings] 'storage.s3.uploadPartSize' should use sentence-style capitalization.
docs/reference/configuration-options.md|113 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|115 col 37| [Google.Passive] In general, use active voice instead of passive voice ('be uploaded').
docs/reference/configuration-options.md|115 col 81| [Google.Units] Put a nonbreaking space between the number and the unit in '10MB'.
docs/reference/configuration-options.md|117 col 106| [Google.Passive] In general, use active voice instead of passive voice ('be uploaded').
docs/reference/configuration-options.md|117 col 180| [Google.Passive] In general, use active voice instead of passive voice ('is calculated').
docs/reference/configuration-options.md|117 col 347| [Vale.Spelling] Did you really mean 'appr'?
docs/reference/configuration-options.md|119 col 28| [Google.Passive] In general, use active voice instead of passive voice ('is printed').
docs/reference/configuration-options.md|121 col 203| [Google.Passive] In general, use active voice instead of passive voice ('is used').
docs/reference/configuration-options.md|123 col 5| [Google.Headings] 'storage.s3.maxUploadParts' should use sentence-style capitalization.
docs/reference/configuration-options.md|126 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|129 col 38| [Google.Passive] In general, use active voice instead of passive voice ('be uploaded').
docs/reference/configuration-options.md|131 col 68| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|135 col 28| [Google.Passive] In general, use active voice instead of passive voice ('is printed').
docs/reference/configuration-options.md|137 col 5| [Google.Headings] 'storage.s3.storageClass' should use sentence-style capitalization.
docs/reference/configuration-options.md|140 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|142 col 156| [Google.Will] Avoid using 'will'.
docs/reference/configuration-options.md|142 col 161| [Google.Passive] In general, use active voice instead of passive voice ('be used').
docs/reference/configuration-options.md|144 col 5| [Google.Headings] 'storage.s3.debugLogLevels' should use sentence-style capitalization.
docs/reference/configuration-options.md|147 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|149 col 78| [Google.Passive] In general, use active voice instead of passive voice ('are printed').
docs/reference/configuration-options.md|155 col 37| [Google.Passive] In general, use active voice instead of passive voice ('is performed').
docs/reference/configuration-options.md|157 col 5| [Google.Headings] 'storage.s3.insecureSkipTLSVerify' should use sentence-style capitalization.
docs/reference/configuration-options.md|159 col 9| [Vale.Spelling] Did you really mean 'bool'?
docs/reference/configuration-options.md|160 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|161 col 10| [Google.Colons] ': F' should be in lowercase.
docs/reference/configuration-options.md|163 col 14| [Google.Acronyms] Spell out 'TLS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|163 col 115| [Vale.Spelling] Did you really mean 'storages'?
docs/reference/configuration-options.md|163 col 145| [Google.Acronyms] Spell out 'TLS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|171 col 5| [Google.Headings] 'serverSideEncryption.sseAlgorithm' should use sentence-style capitalization.
docs/reference/configuration-options.md|174 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|176 col 92| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|176 col 96| [Google.Acronyms] Spell out 'KMS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|180 col 5| [Google.Headings] 'serverSideEncryption.kmsKeyID' should use sentence-style capitalization.
docs/reference/configuration-options.md|183 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|185 col 41| [Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|185 col 45| [Google.Acronyms] Spell out 'KMS', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|187 col 5| [Google.Headings] 'serverSideEncryption.sseCustomerAlgorithm' should use sentence-style capitalization.
docs/reference/configuration-options.md|190 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|192 col 81| [Google.Parens] Use parentheses judiciously.
docs/reference/configuration-options.md|192 col 82| [Google.Acronyms] Spell out 'SSE', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|196 col 5| [Google.Headings] 'serverSideEncryption.sseCustomerKey' should use sentence-style capitalization.
docs/reference/configuration-options.md|199 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|201 col 38| [Google.Contractions] Use 'isn't' instead of 'is not'.
docs/reference/configuration-options.md|201 col 82| [Google.Contractions] Use 'it's' instead of 'it is'.
docs/reference/configuration-options.md|201 col 127| [Google.Passive] In general, use active voice instead of passive voice ('is encrypted').
docs/reference/configuration-options.md|205 col 5| [Google.Headings] 'retryer.numMaxRetries' should use sentence-style capitalization.
docs/reference/configuration-options.md|208 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|211 col 91| [Google.Will] Avoid using 'will'.
docs/reference/configuration-options.md|211 col 96| [Google.Passive] In general, use active voice instead of passive voice ('be performed').
docs/reference/configuration-options.md|213 col 5| [Google.Headings] 'retryer.minRetryDelay' should use sentence-style capitalization.
docs/reference/configuration-options.md|215 col 12| [Google.Spacing] 'e.D' should have one space.
docs/reference/configuration-options.md|216 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|219 col 18| [Google.Parens] Use parentheses judiciously.
docs/reference/configuration-options.md|221 col 5| [Google.Headings] 'retryer.maxRetryDelay' should use sentence-style capitalization.
docs/reference/configuration-options.md|223 col 12| [Google.Spacing] 'e.D' should have one space.
docs/reference/configuration-options.md|224 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|227 col 18| [Google.Parens] Use parentheses judiciously.
docs/reference/configuration-options.md|238 col 5| [Google.Headings] 'storage.filesystem.path' should use sentence-style capitalization.
docs/reference/configuration-options.md|241 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|241 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|258 col 5| [Google.Headings] 'storage.azure.account' should use sentence-style capitalization.
docs/reference/configuration-options.md|261 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|261 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|265 col 5| [Google.Headings] 'storage.azure.container' should use sentence-style capitalization.
docs/reference/configuration-options.md|268 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|268 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/configuration-options.md|272 col 5| [Google.Headings] 'storage.azure.prefix' should use sentence-style capitalization.
docs/reference/configuration-options.md|275 col 11| [Google.Colons] ': N' should be in lowercase.
docs/reference/configuration-options.md|277 col 10| [Google.Parens] Use parentheses judiciously.
docs/reference/configuration-options.md|277 col 82| [Google.Passive] In general, use active voice instead of passive voice ('are stored').
docs/reference/configuration-options.md|279 col 5| [Google.Headings] 'storage.azure.credentials.key' should use sentence-style capitalization.
docs/reference/configuration-options.md|282 col 11| [Google.Colons] ': Y' should be in lowercase.
docs/reference/configuration-options.md|282 col 13| [Google.Acronyms] Spell out 'YES', if it's unfamiliar to the audience.
docs/reference/contributing.md|3 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
docs/reference/contributing.md|13 col 82| [Google.Acronyms] Spell out 'JIRA', if it's unfamiliar to the audience.
docs/reference/contributing.md|17 col 62| [Vale.Spelling] Did you really mean 'upvote'?
docs/reference/contributing.md|23 col 16| [Google.Acronyms] Spell out 'JIRA', if it's unfamiliar to the audience.
docs/reference/contributing.md|23 col 80| [Google.Will] Avoid using 'will'.
docs/reference/contributing.md|24 col 1| [Google.Contractions] Use 'don't' instead of 'do not'.
docs/reference/contributing.md|41 col 45| [Google.Acronyms] Spell out 'JIRA', if it's unfamiliar to the audience.
docs/reference/contributing.md|45 col 56| [Google.Acronyms] Spell out 'JIRA', if it's unfamiliar to the audience.
docs/reference/contributing.md|57 col 27| [Google.WordList] Use 'select' instead of 'check'.
docs/reference/contributing.md|65 col 294| [Google.Spacing] 'e. T' should have one space.

Annotations

Check warning on line 8 in snippets/install-result.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] snippets/install-result.md#L8

[Google.WordList] Use 'app' instead of 'application'.
Raw output
{"message": "[Google.WordList] Use 'app' instead of 'application'.", "location": {"path": "snippets/install-result.md", "range": {"start": {"line": 8, "column": 43}}}, "severity": "WARNING"}

Check notice on line 6 in snippets/pbm-install-nodes.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] snippets/pbm-install-nodes.md#L6

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "snippets/pbm-install-nodes.md", "range": {"start": {"line": 6, "column": 17}}}, "severity": "INFO"}

Check warning on line 1 in docs/installation.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/installation.md#L1

[Google.Headings] 'Quickstart Guides' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Quickstart Guides' should use sentence-style capitalization.", "location": {"path": "docs/installation.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Check warning on line 7 in docs/installation.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/installation.md#L7

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "docs/installation.md", "range": {"start": {"line": 7, "column": 50}}}, "severity": "WARNING"}

Check warning on line 9 in docs/installation.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/installation.md#L9

[Google.Colons] ': P' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': P' should be in lowercase.", "location": {"path": "docs/installation.md", "range": {"start": {"line": 9, "column": 29}}}, "severity": "WARNING"}

Check warning on line 18 in docs/installation.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/installation.md#L18

[Google.Colons] ': D' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': D' should be in lowercase.", "location": {"path": "docs/installation.md", "range": {"start": {"line": 18, "column": 20}}}, "severity": "WARNING"}

Check warning on line 26 in docs/installation.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/installation.md#L26

[Google.Colons] ': K' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': K' should be in lowercase.", "location": {"path": "docs/installation.md", "range": {"start": {"line": 26, "column": 24}}}, "severity": "WARNING"}

Check warning on line 34 in docs/installation.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/installation.md#L34

[Google.Colons] ': B' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': B' should be in lowercase.", "location": {"path": "docs/installation.md", "range": {"start": {"line": 34, "column": 28}}}, "severity": "WARNING"}

Check warning on line 42 in docs/installation.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/installation.md#L42

[Google.Colons] ': M' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': M' should be in lowercase.", "location": {"path": "docs/installation.md", "range": {"start": {"line": 42, "column": 27}}}, "severity": "WARNING"}

Check warning on line 1 in docs/install/backup-storage.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/backup-storage.md#L1

[Google.Headings] 'Configure remote backup storage' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Configure remote backup storage' should use sentence-style capitalization.", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Check warning on line 5 in docs/install/backup-storage.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/backup-storage.md#L5

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 5, "column": 75}}}, "severity": "WARNING"}

Check failure on line 5 in docs/install/backup-storage.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/backup-storage.md#L5

[Vale.Spelling] Did you really mean 'storages'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'storages'?", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 5, "column": 145}}}, "severity": "ERROR"}

Check notice on line 8 in docs/install/backup-storage.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/backup-storage.md#L8

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 8, "column": 1}}}, "severity": "INFO"}

Check failure on line 8 in docs/install/backup-storage.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/backup-storage.md#L8

[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw output
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 8, "column": 26}}}, "severity": "ERROR"}

Check notice on line 12 in docs/install/backup-storage.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/backup-storage.md#L12

[Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'AWS', if it's unfamiliar to the audience.", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 12, "column": 58}}}, "severity": "INFO"}

Check notice on line 60 in docs/install/backup-storage.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/backup-storage.md#L60

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/install/backup-storage.md", "range": {"start": {"line": 60, "column": 122}}}, "severity": "INFO"}

Check notice on line 7 in docs/install/initial-setup.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/initial-setup.md#L7

[Google.Contractions] Use 'that's' instead of 'that is'.
Raw output
{"message": "[Google.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/install/initial-setup.md", "range": {"start": {"line": 7, "column": 109}}}, "severity": "INFO"}

Check warning on line 9 in docs/install/repos.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/repos.md#L9

[Google.Colons] ': W' should be in lowercase.
Raw output
{"message": "[Google.Colons] ': W' should be in lowercase.", "location": {"path": "docs/install/repos.md", "range": {"start": {"line": 9, "column": 27}}}, "severity": "WARNING"}

Check warning on line 7 in docs/install/source.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/source.md#L7

[Google.WordList] Use 'preceding' instead of 'above'.
Raw output
{"message": "[Google.WordList] Use 'preceding' instead of 'above'.", "location": {"path": "docs/install/source.md", "range": {"start": {"line": 7, "column": 14}}}, "severity": "WARNING"}

Check notice on line 33 in docs/install/source.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/source.md#L33

[Google.Passive] In general, use active voice instead of passive voice ('been built').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('been built').", "location": {"path": "docs/install/source.md", "range": {"start": {"line": 33, "column": 46}}}, "severity": "INFO"}

Check notice on line 3 in docs/install/start-pbm-agent.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/start-pbm-agent.md#L3

[Google.Contractions] Use 'it's' instead of 'It is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "docs/install/start-pbm-agent.md", "range": {"start": {"line": 3, "column": 69}}}, "severity": "INFO"}

Check failure on line 10 in docs/install/start-pbm-agent.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/start-pbm-agent.md#L10

[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw output
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/install/start-pbm-agent.md", "range": {"start": {"line": 10, "column": 275}}}, "severity": "ERROR"}

Check failure on line 10 in docs/install/start-pbm-agent.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/start-pbm-agent.md#L10

[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw output
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/install/start-pbm-agent.md", "range": {"start": {"line": 10, "column": 361}}}, "severity": "ERROR"}

Check notice on line 13 in docs/install/start-pbm-agent.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/start-pbm-agent.md#L13

[Google.Passive] In general, use active voice instead of passive voice ('is redirected').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is redirected').", "location": {"path": "docs/install/start-pbm-agent.md", "range": {"start": {"line": 13, "column": 8}}}, "severity": "INFO"}

Check notice on line 13 in docs/install/start-pbm-agent.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/install/start-pbm-agent.md#L13

[Google.Passive] In general, use active voice instead of passive voice ('is backgrounded').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is backgrounded').", "location": {"path": "docs/install/start-pbm-agent.md", "range": {"start": {"line": 13, "column": 48}}}, "severity": "INFO"}