search

mautic / developer-documentation-new

New developer documentation on Read the Docs
https://mautic-developer.readthedocs.io
6 stars 26 forks source link

Fix remaining Vale warnings/errors in codebase #22

Closed dennisameling closed 8 months ago

dennisameling commented 2 years ago

Needs #21 to be merged first.

When running vale ., there's quite some errors and warnings showing up, but at least the errors should be easy to fix!

Click for details ```shell % vale . .vscode/welcome.md 1:52 error Don't use exclamation points Google.Exclamation in text. 3:1 warning Try to avoid using Google.We first-person plural like 'We'. 4:1 suggestion Use parentheses judiciously. Google.Parens 5:62 suggestion Spell out 'LIVE', if it's Google.Acronyms unfamiliar to the audience. 9:13 error Don't use exclamation points Google.Exclamation in text. README.md 3:12 error Did you really mean 'Gitpod'? Vale.Spelling 5:34 suggestion Use parentheses judiciously. Google.Parens 7:126 suggestion In general, use active voice Google.Passive instead of passive voice ('is merged'). 7:145 suggestion In general, use active voice Google.Passive instead of passive voice ('are deployed'). 9:23 warning Try to avoid using Google.We first-person plural like 'our'. 11:4 warning 'Migration of developer docs Google.Headings to Read the Docs' should use sentence-style capitalization. 13:1 warning Try to avoid using Google.We first-person plural like 'We'. 13:76 suggestion Use parentheses judiciously. Google.Parens 13:103 suggestion Spell out 'REST', if it's Google.Acronyms unfamiliar to the audience. 14:164 warning Try to avoid using Google.We first-person plural like 'we'. 16:22 warning Try to avoid using Google.We first-person plural like 'our'. 16:47 warning Try to avoid using Google.We first-person plural like 'us'. 16:83 warning Use 'select' instead of Google.WordList 'check'. 16:154 error Don't use exclamation points Google.Exclamation in text. 22:4 suggestion Spell out 'RST', if it's Google.Acronyms unfamiliar to the audience. 30:23 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Theme' instead of 'theme'. 33:9 warning Avoid using 'will'. Google.Will 33:42 error Use 'HTML' instead of 'html'. Vale.Terms 33:99 error Use 'HTML' instead of 'html'. Vale.Terms 33:123 error Use 'HTML' instead of 'html'. Vale.Terms 33:134 error Use 'HTML' instead of 'html'. Vale.Terms 40:5 warning 'PhpStorm/PyCharm File Google.Headings Watcher' should use sentence-style capitalization. 41:40 error Did you really mean 'rst'? Vale.Spelling docs/components/channels.rst 5:19 suggestion Is this referring to a Mautic.FeatureList Mautic feature? If so, use 'Integration' instead of 'integration'. docs/components/emails.rst 8:1 error Use 'Todo' instead of 'todo'. Vale.Terms 13:1 error Use 'Todo' instead of 'todo'. Vale.Terms docs/components/integrations.rst 18:1 warning 'Integration Builders' Google.Headings should use sentence-style capitalization. docs/components/security.rst 13:8 warning Use 'single sign-on' instead Google.WordList of 'sign-on'. docs/components/sms.rst 4:1 warning 'Text Message transports' Google.Headings should use sentence-style capitalization. docs/components/tracking_script.rst 5:5 warning ': I' should be in lowercase. Google.Colons 7:5 warning ': U' should be in lowercase. Google.Colons docs/components/translator.rst 11:19 suggestion Spell out 'INI', if it's Google.Acronyms unfamiliar to the audience. 17:74 warning Try to avoid using Google.We first-person plural like 'US'. 26:43 suggestion Spell out 'INI', if it's Google.Acronyms unfamiliar to the audience. 31:69 suggestion In general, use active voice Google.Passive instead of passive voice ('are defined'). 48:345 suggestion In general, use active voice Google.Passive instead of passive voice ('are wrapped'). 57:1 warning 'Using the Translator service' Google.Headings should use sentence-style capitalization. docs/form_hooks/response_hooks.rst 75:74 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. docs/form_hooks/getting_started.rst 1:1 warning 'Getting started with Google.Headings Form hooks' should use sentence-style capitalization. 8:161 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Forms' instead of 'forms'. docs/marketplace/allowlist_what_and_why.rst 2:1 error Use 'allowlist' instead of Vale.Terms 'Allowlist'. 2:12 suggestion Feel free to use 'what's' Google.Contractions instead of 'what is'. 5:61 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugin' instead of 'plugin'. 6:393 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. 20:167 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Email' instead of 'email'. 26:88 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugins' instead of 'plugins'. docs/marketplace/best_practices.rst 5:15 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugins' instead of 'plugins'. 7:96 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. 8:67 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. 8:85 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Report' instead of 'report'. 10:108 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. 11:127 error Use 'PUT' instead of 'put'. Vale.Terms 11:192 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. 13:70 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugin' instead of 'plugin'. docs/marketplace/getting_started.rst 5:73 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'User' instead of 'user'. 7:85 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugins' instead of 'plugins'. 7:105 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugins' instead of 'plugins'. 8:65 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugins' instead of 'plugins'. 10:1 error Use 'Todo' instead of 'TODO'. Vale.Terms 10:6 suggestion Use parentheses judiciously. Google.Parens 17:46 error Use 'Todo' instead of 'TODO'. Vale.Terms 17:51 suggestion Use parentheses judiciously. Google.Parens 17:52 suggestion Spell out 'LINK', if it's Google.Acronyms unfamiliar to the audience. docs/marketplace/listing.rst 12:128 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. 16:23 error Use 'Composer' instead of Vale.Terms 'composer'. 21:19 error Use 'Composer' instead of Vale.Terms 'composer'. 41:56 error Use 'Composer' instead of Vale.Terms 'composer'. 45:191 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. 52:127 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 57:10 error Use 'Composer' instead of Vale.Terms 'composer'. 62:314 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 69:33 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugin' instead of 'plugin'. docs/plugins/getting_started.rst 1:1 warning 'Getting started with Plugins' Google.Headings should use sentence-style capitalization. docs/plugins/installation.rst 6:132 warning Avoid using 'will'. Google.Will 6:149 suggestion In general, use active voice Google.Passive instead of passive voice ('be used'). docs/themes/forms.rst 1:13 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Forms' instead of 'forms'. 11:295 suggestion Spell out 'PHP', if it's Google.Acronyms unfamiliar to the audience. docs/plugins/translations.rst 1:13 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Plugins' instead of 'plugins'. 6:38 warning Try to avoid using Google.We first-person plural like 'US'. docs/plugins/mautic_vs_symfony.rst 1:1 warning 'Deviations from standard Google.Headings Symfony Framework' should use sentence-style capitalization. 24:51 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Assets' instead of 'assets'. 62:159 error Use 'FALSE' instead of Vale.Terms 'false'. 68:1 warning 'Firewalls and User access Google.Headings management' should use sentence-style capitalization. 70:44 warning Use 'firewall rules' instead Google.WordList of 'firewalls'. 70:124 warning Use 'firewall rules' instead Google.WordList of 'firewalls'. 78:1 warning 'Custom Translator' should use Google.Headings sentence-style capitalization. 80:70 suggestion Is this referring to a Mautic.FeatureList Mautic feature? If so, use 'Component' instead of 'component'. 80:178 warning Try to avoid using Google.We first-person plural like 'US'. docs/themes/grapesjs.rst 1:1 warning 'GrapesJS Builder' should use Google.Headings sentence-style capitalization. 4:181 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Emails' instead of 'emails'. docs/themes/system.rst 6:37 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. docs/themes/getting_started.rst 1:1 warning 'Getting started with Themes' Google.Headings should use sentence-style capitalization. 6:43 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Pages' instead of 'pages'. 6:77 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 6:140 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 13:27 suggestion Is this referring to a Mautic.FeatureList Mautic feature? If so, use 'Components' instead of 'components'. 54:19 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Theme' instead of 'theme'. 56:18 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Theme' instead of 'theme'. 58:18 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Theme' instead of 'theme'. 58:47 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 67:1 warning 'html/message.html.twig' Google.Headings should use sentence-style capitalization. 67:1 error Use 'HTML' instead of 'html'. Vale.Terms 67:14 error Use 'HTML' instead of 'html'. Vale.Terms 70:57 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Contact' instead of 'Lead'. 70:107 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Emails' instead of 'emails'. 74:59 suggestion In general, use active voice Google.Passive instead of passive voice ('been unsubscribed'). 74:76 warning In general, don't use an Google.Ellipses ellipsis. 76:97 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 92:1 error Use 'HTML' instead of 'html'. Vale.Terms 92:1 warning 'html/email.html.twig' Google.Headings should use sentence-style capitalization. 92:6 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Email' instead of 'email'. 92:12 error Use 'HTML' instead of 'html'. Vale.Terms 95:98 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Email' instead of 'email'. 136:1 error Use 'HTML' instead of 'html'. Vale.Terms 136:1 warning 'html/page.html.twig' Google.Headings should use sentence-style capitalization. 136:6 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 160:1 warning 'html/form.html.twig' Google.Headings should use sentence-style capitalization. 160:1 error Use 'HTML' instead of 'html'. Vale.Terms 160:6 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 163:42 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 163:51 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 163:162 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 192:151 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 192:175 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. docs/plugins/config.rst 1:1 error Use 'config' instead of Vale.Terms 'Config'. 95:9 warning Use 'firewall rules' instead Google.WordList of 'firewalls'. 98:15 warning Use 'firewall rules' instead Google.WordList of 'firewalls'. 119:117 warning Use 'firewall rules' instead Google.WordList of 'firewalls'. 121:70 warning Use 'firewall rules' instead Google.WordList of 'firewalls'. 134:9 suggestion In general, use active voice Google.Passive instead of passive voice ('Is required'). 156:152 suggestion In general, use active voice Google.Passive instead of passive voice ('is ignored'). 179:36 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 179:61 suggestion In general, use active voice Google.Passive instead of passive voice ('be used'). 326:9 suggestion In general, use active voice Google.Passive instead of passive voice ('Is required'). 417:71 error Use 'TRUE' instead of 'true'. Vale.Terms 488:25 warning Avoid using 'will'. Google.Will 530:9 suggestion In general, use active voice Google.Passive instead of passive voice ('Is required'). 552:139 suggestion In general, use active voice Google.Passive instead of passive voice ('is set'). 572:50 suggestion In general, use active voice Google.Passive instead of passive voice ('is instantiated'). 620:42 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Webhooks' instead of 'webhooks'. 703:222 suggestion Use semicolons judiciously. Google.Semicolons 703:256 suggestion Use semicolons judiciously. Google.Semicolons 703:297 suggestion Use semicolons judiciously. Google.Semicolons docs/themes/legacy.rst 1:1 warning 'Legacy Builder' should use Google.Headings sentence-style capitalization. 4:79 suggestion In general, use active voice Google.Passive instead of passive voice ('be deleted'). 42:27 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'User' instead of 'user'. 42:77 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Email' instead of 'email'. 42:163 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'User' instead of 'user'. 52:18 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'User' instead of 'user'. 52:139 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'User' instead of 'user'. 59:65 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'User' instead of 'user'. 81:95 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Theme' instead of 'theme'. 81:147 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Users' instead of 'users'. docs/webhooks/events/company_post_delete.rst 27:69 warning Avoid using 'will'. Google.Will 30:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. docs/webhooks/events/company_post_save.rst 26:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 44:16 error Use 'TRUE' instead of 'true'. Vale.Terms 47:31 suggestion In general, use active voice Google.Passive instead of passive voice ('was created'). 47:46 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 56:52 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 56:82 suggestion Feel free to use 'hasn't' Google.Contractions instead of 'has not'. 56:90 suggestion In general, use active voice Google.Passive instead of passive voice ('been modified'). 95:38 suggestion Use parentheses judiciously. Google.Parens 98:17 suggestion In general, use active voice Google.Passive instead of passive voice ('are grouped'). 98:370 suggestion In general, use active voice Google.Passive instead of passive voice ('is set'). docs/webhooks/events/form_on_submit.rst 27:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 57:46 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 66:124 suggestion In general, use active voice Google.Passive instead of passive voice ('was embedded'). docs/webhooks/events/lead_channel_subscription_changed.rst 1:9 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Channel' instead of 'channel'. 4:43 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Channel' instead of 'channel'. 28:13 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Channel' instead of 'channel'. 28:33 suggestion In general, use active voice Google.Passive instead of passive voice ('was unsubscribed'). 31:52 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Channel' instead of 'channel'. 34:47 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Channel' instead of 'channel'. 37:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. docs/webhooks/events/lead_company_change.rst 1:1 warning 'Contact Company subscription Google.Headings change event' should use sentence-style capitalization. 24:33 suggestion In general, use active voice Google.Passive instead of passive voice ('was added'). 33:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. docs/webhooks/events/email_on_send.rst 33:37 error Did you really mean Vale.Spelling 'templated'? 45:138 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Email' instead of 'email'. 45:156 warning Avoid using 'will'. Google.Will 51:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 72:29 suggestion In general, use active voice Google.Passive instead of passive voice ('was created'). 72:44 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 81:50 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 81:80 suggestion Feel free to use 'hasn't' Google.Contractions instead of 'has not'. 81:88 suggestion In general, use active voice Google.Passive instead of passive voice ('been modified'). 84:70 suggestion Feel free to use 'hasn't' Google.Contractions instead of 'has not'. 84:78 suggestion In general, use active voice Google.Passive instead of passive voice ('been modified'). 111:9 error Use 'TRUE' instead of 'True'. Vale.Terms 111:42 suggestion In general, use active voice Google.Passive instead of passive voice ('be set'). 117:28 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Email' instead of 'email'. 120:20 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Theme' instead of 'theme'. 123:62 suggestion Use parentheses judiciously. Google.Parens 126:43 suggestion In general, use active voice Google.Passive instead of passive voice ('been opened'). 129:43 suggestion In general, use active voice Google.Passive instead of passive voice ('been sent'). 132:43 suggestion In general, use active voice Google.Passive instead of passive voice ('been edited'). 138:28 suggestion Spell out 'UTM', if it's Google.Acronyms unfamiliar to the audience. 138:28 error Use 'utm' instead of 'UTM'. Vale.Terms 138:65 suggestion In general, use active voice Google.Passive instead of passive voice ('are supported'). 141:36 suggestion In general, use active voice Google.Passive instead of passive voice ('be published'). 141:52 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 144:36 suggestion In general, use active voice Google.Passive instead of passive voice ('be considered'). 144:65 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 150:89 suggestion Feel free to use 'isn't' Google.Contractions instead of 'is not'. 153:43 suggestion In general, use active voice Google.Passive instead of passive voice ('been sent'). 156:43 suggestion In general, use active voice Google.Passive instead of passive voice ('been read'). 213:68 suggestion Feel free to use 'hasn't' Google.Contractions instead of 'has not'. 213:76 suggestion In general, use active voice Google.Passive instead of passive voice ('been modified'). 243:43 suggestion In general, use active voice Google.Passive instead of passive voice ('been edited'). 249:31 suggestion In general, use active voice Google.Passive instead of passive voice ('was uploaded'). 249:68 suggestion In general, use active voice Google.Passive instead of passive voice ('is hosted'). 264:45 suggestion In general, use active voice Google.Passive instead of passive voice ('been downloaded'). 306:87 suggestion In general, use active voice Google.Passive instead of passive voice ('been modified'). 330:30 suggestion In general, use active voice Google.Passive instead of passive voice ('is related'). 350:5 warning 'Unsubscribe Form properties' Google.Headings should use sentence-style capitalization. 381:64 suggestion Feel free to use 'hasn't' Google.Contractions instead of 'has not'. 381:72 suggestion In general, use active voice Google.Passive instead of passive voice ('been modified'). 384:35 suggestion In general, use active voice Google.Passive instead of passive voice ('be published'). 384:51 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 387:35 suggestion In general, use active voice Google.Passive instead of passive voice ('be considered'). 387:64 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 393:55 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 399:53 suggestion In general, use active voice Google.Passive instead of passive voice ('been submitted'). 402:31 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'User' instead of 'user'. 405:61 suggestion In general, use active voice Google.Passive instead of passive voice ('is disabled'). 405:64 warning Use 'turn off' or 'off' Google.WordList instead of 'disabled'. 411:62 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Pages' instead of 'pages'. 414:39 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 422:5 warning 'Unsubscribe Form field Google.Headings properties' should use sentence-style capitalization. 456:41 suggestion In general, use active voice Google.Passive instead of passive voice ('is required'). 485:5 warning 'Unsubscribe Form action Google.Headings properties' should use sentence-style capitalization. docs/webhooks/events/lead_points_change.rst 1:9 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Points' instead of 'points'. 3:44 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Points' instead of 'points'. 36:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. docs/webhooks/events/lead_post_delete.rst 27:69 warning Avoid using 'will'. Google.Will 30:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. docs/webhooks/events/lead_post_save_new.rst 28:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 46:16 error Use 'TRUE' instead of 'true'. Vale.Terms 49:31 suggestion In general, use active voice Google.Passive instead of passive voice ('was created'). 49:46 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 58:31 suggestion In general, use active voice Google.Passive instead of passive voice ('was identified'). 58:49 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 61:52 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 61:82 suggestion Feel free to use 'hasn't' Google.Contractions instead of 'has not'. 61:90 suggestion In general, use active voice Google.Passive instead of passive voice ('been modified'). 79:17 suggestion In general, use active voice Google.Passive instead of passive voice ('are grouped'). 79:370 suggestion In general, use active voice Google.Passive instead of passive voice ('is set'). 82:50 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 82:80 suggestion Feel free to use 'hasn't' Google.Contractions instead of 'has not'. 85:66 suggestion In general, use active voice Google.Passive instead of passive voice ('is assigned'). 105:5 warning 'Custom Field properties' Google.Headings should use sentence-style capitalization. 133:51 warning Avoid using 'will'. Google.Will 165:4 warning 'IP Address properties' Google.Headings should use sentence-style capitalization. 187:27 suggestion In general, use active voice Google.Passive instead of passive voice ('is located'). 190:29 suggestion In general, use active voice Google.Passive instead of passive voice ('is located'). 193:31 suggestion In general, use active voice Google.Passive instead of passive voice ('is located'). 196:35 suggestion In general, use active voice Google.Passive instead of passive voice ('is located'). 199:36 suggestion In general, use active voice Google.Passive instead of passive voice ('is located'). 202:9 suggestion Spell out 'ISP', if it's Google.Acronyms unfamiliar to the audience. 205:29 suggestion In general, use active voice Google.Passive instead of passive voice ('is assigned'). 247:51 suggestion In general, use active voice Google.Passive instead of passive voice ('is unsubscribed'). 247:89 suggestion In general, use active voice Google.Passive instead of passive voice ('is bounced'). docs/webhooks/events/sms_on_send.rst 33:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. docs/webhooks/events/page_on_hit.rst 1:1 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 27:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 29:5 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 42:19 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 45:41 suggestion Spell out 'ISO', if it's Google.Acronyms unfamiliar to the audience. 57:107 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'page'. 69:9 suggestion Spell out 'ISP', if it's Google.Acronyms unfamiliar to the audience. 75:32 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 78:26 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 81:21 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 84:9 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Landing Page' instead of 'Page'. 115:5 warning 'Landing Page basic Google.Headings properties' should use sentence-style capitalization. docs/webhooks/example_scripts.rst 67:1 warning 'Node.js' should use Google.Headings sentence-style capitalization. docs/webhooks/getting_started.rst 1:22 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Webhooks' instead of 'webhooks'. 4:164 suggestion In general, use active voice Google.Passive instead of passive voice ('be sent'). 6:131 warning Avoid using 'will'. Google.Will 38:70 suggestion In general, use active voice Google.Passive instead of passive voice ('be used'). 40:52 suggestion Use parentheses judiciously. Google.Parens 40:53 suggestion Spell out 'PMS', if it's Google.Acronyms unfamiliar to the audience. 49:8 suggestion Spell out 'PMS', if it's Google.Acronyms unfamiliar to the audience. 59:8 suggestion Spell out 'PMS', if it's Google.Acronyms unfamiliar to the audience. 61:1 warning 'Configuring Webhooks' Google.Headings should use sentence-style capitalization. 82:1 warning 'Creating a Webhook' Google.Headings should use sentence-style capitalization. 84:134 suggestion In general, use active voice Google.Passive instead of passive voice ('is exposed'). 88:168 suggestion Feel free to use 'that's' Google.Contractions instead of 'that is'. 92:1 warning 'Testing a Webhook' should use Google.Headings sentence-style capitalization. 97:100 suggestion Is this referring to a Mautic Mautic.FeatureList feature? If so, use 'Form' instead of 'form'. 103:1 warning 'Securing a Webhook' Google.Headings should use sentence-style capitalization. 106:37 suggestion Spell out 'HMAC', if it's Google.Acronyms unfamiliar to the audience. 106:343 suggestion Spell out 'HMAC', if it's Google.Acronyms unfamiliar to the audience. 110:63 suggestion In general, use active voice Google.Passive instead of passive voice ('be ignored'). ✖ 33 errors, 58 warnings and 209 suggestions in 62 files. ```
RCheesley commented 2 years ago

OK so this issue is to fix the problems thrown up in the report, if I understand it correctly?

dennisameling commented 2 years ago

@RCheesley yes! The GitHub Action is currently configured to only check files that were changed in PRs, so it doesn't go over the entire docs folder yet: https://github.com/mautic/developer-documentation-new/blob/e70177d3c3208032d356c6c20804f679c174de45/.github/workflows/linting.yml#L22

We can't enable the checks on the entire folder until we've fixed all errors (and probably warnings as well, depending on how strict we want to be)

RCheesley commented 2 years ago

Ah great! @fakela this would be a nice one for someone new to take on I think, although there may be some which are errors we may wish to exclude as I know Alan has some he came across which threw an error on a valid use of syntax for the linking extension.

dennisameling commented 1 year ago

Vale is now active on the entire codebase and only runs on changed files. Assigning to @RCheesley for fixing the remaining issues in the existing codebase.