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

Guides reorganization for initial IA + vendorization #3368

Merged
merged 30 commits into from
Sep 8, 2023

Merge branch 'main' into vendor/3348-guides

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

Guides reorganization for initial IA + vendorization #3368

Merge branch 'main' into vendor/3348-guides
f3f81ac
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale failed Aug 23, 2023 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (10)

sites/platform/src/_index.md|8 col 39| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/_index.md|8 col 186| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/_index.md|26 col 99| [Platform.there-start] Try to avoid starting sentences with 'It is'.
sites/platform/src/_index.md|26 col 99| [Platform.contractions] Feel free to use a contraction instead of 'It is'
sites/platform/src/_index.md|33 col 26| [Platform.first-person] Try to avoid using the first person like 'my'.
sites/platform/src/_index.md|33 col 46| [Platform.first-person] Try to avoid using the first person like ' I '.
sites/platform/src/_index.md|43 col 80| [Platform.latin] Use '' instead of ', etc'.
sites/platform/src/_index.md|44 col 180| [Platform.latin] Use '' instead of ', etc'.
sites/platform/src/add-services/opensearch.md|131 col 68| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/add-services/elasticsearch.md|186 col 68| [Platform.link-text] Try to use meaningful text for links.

Filtered Findings (738)

sites/platform/src/get-started/deploy/init.md|27 col 66| [Platform.future] Avoid using 'won't'. Stick to the present tense.
sites/platform/src/get-started/monitor-and-troubleshoot/status.md|78 col 14| [Platform.contractions] Feel free to use a contraction instead of 'is not'
sites/platform/src/get-started/monitor-and-troubleshoot/log.md|43 col 57| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/environments/search-engine-visibility.md|8 col 62| [Platform.abbreviations] Spell out 'SEO' if it's unfamiliar to the audience.
sites/platform/src/environments/http-access-control.md|61 col 33| [Platform.abbreviations] Spell out 'CIDR' if it's unfamiliar to the audience.
sites/platform/src/_index.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 19.48
sites/platform/src/environments/scalability.md|42 col 1| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/environments/default-environment.md|181 col 88| [Platform.editorializing] Considering avoiding 'completely' to keep the text more neutral.
sites/platform/src/environments/backup.md|28 col 4| [Platform.contractions] Feel free to use a contraction instead of 'That is'
sites/platform/src/languages/dotnet.md|34 col 25| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'however'. This makes it simpler and clearer.
sites/platform/src/languages/dotnet.md|55 col 1| [Platform.there-start] Try to avoid starting sentences with 'There is'.
sites/platform/src/languages/dotnet.md|63 col 112| [Platform.abbreviations] Spell out 'MVC' if it's unfamiliar to the audience.
sites/platform/src/languages/lisp.md|24 col 21| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/languages/lisp.md|35 col 81| [Platform.abbreviations] Spell out 'ASDF' if it's unfamiliar to the audience.
sites/platform/src/languages/lisp.md|35 col 142| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/languages/lisp.md|73 col 175| [Platform.editorializing] Considering avoiding 'very' to keep the text more neutral.
sites/platform/src/languages/lisp.md|73 col 181| [Platform.editorializing] Considering avoiding 'very' to keep the text more neutral.
sites/platform/src/languages/php/extensions.md|64 col 46| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/languages/php/tuning.md|41 col 52| [Platform.abbreviations] Spell out 'CGI' if it's unfamiliar to the audience.
sites/platform/src/languages/php/_index.md|413 col 12| [Platform.abbreviations] Spell out 'CGI' if it's unfamiliar to the audience.
sites/platform/src/languages/php/_index.md|531 col 16| [Platform.abbreviations] Spell out 'FFI' if it's unfamiliar to the audience.
sites/platform/src/languages/java/tuning.md|7 col 1| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/languages/java/tuning.md|7 col 7| [Platform.editorializing] Considering avoiding 'are a number' to keep the text more neutral.
sites/platform/src/languages/java/tuning.md|11 col 61| [Platform.contractions] Feel free to use a contraction instead of 'it is'
sites/platform/src/languages/java/tuning.md|18 col 21| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/languages/java/tuning.md|28 col 56| [Platform.contractions] Feel free to use a contraction instead of 'it is'
sites/platform/src/languages/java/tuning.md|45 col 90| [Platform.editorializing] Considering avoiding 'basically' to keep the text more neutral.
sites/platform/src/languages/java/tuning.md|79 col 49| [Platform.abbreviations] Spell out 'LTS' if it's unfamiliar to the audience.
sites/platform/src/languages/java/tuning.md|80 col 1| [Platform.contractions] Feel free to use a contraction instead of 'That is'
sites/platform/src/languages/java/tuning.md|83 col 1| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/languages/java/tuning.md|87 col 18| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/languages/java/tuning.md|88 col 1| [Platform.first-person] Try to avoid using the first person like 'We'.
sites/platform/src/languages/java/tuning.md|91 col 76| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/languages/java/tuning.md|99 col 19| [Platform.first-person] Try to avoid using the first person like 'my'.
sites/platform/src/languages/java/frameworks.md|9 col 12| [Platform.abbreviations] Spell out 'ORM' if it's unfamiliar to the audience.
sites/platform/src/languages/java/frameworks.md|42 col 4| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/languages/java/frameworks.md|47 col 103| [Platform.editorializing] Considering avoiding 'extremely' to keep the text more neutral.
sites/platform/src/languages/java/frameworks.md|58 col 20| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/languages/java/frameworks.md|63 col 321| [Platform.abbreviations] Spell out 'MVC' if it's unfamiliar to the audience.
sites/platform/src/languages/java/frameworks.md|81 col 11| [Platform.abbreviations] Spell out 'MVC' if it's unfamiliar to the audience.
sites/platform/src/languages/java/frameworks.md|82 col 32| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/languages/java/frameworks.md|111 col 4| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/languages/go.md|28 col 329| [Platform.contractions] Feel free to use a contraction instead of 'it is'
sites/platform/src/languages/java/migration.md|7 col 1| [Platform.there-start] Try to avoid starting sentences with 'It is'.
sites/platform/src/languages/java/migration.md|7 col 1| [Platform.contractions] Feel free to use a contraction instead of 'It is'
sites/platform/src/languages/java/migration.md|56 col 75| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/languages/java/migration.md|75 col 31| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/languages/java/migration.md|111 col 1| [Platform.serial-comma] Use the serial comma in 'has services managed by ** itself such as database, cache and'.
sites/platform/src/languages/java/migration.md|111 col 142| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/languages/java/migration.md|113 col 45| [Platform.contractions] Feel free to use a contraction instead of 'it is'
sites/platform/src/languages/java/migration.md|137 col 16| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/languages/java/migration.md|138 col 11| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/languages/rust.md|33 col 42| [Platform.contractions] Feel free to use a contraction instead of 'it is'
sites/platform/src/languages/python/server.md|14 col 52| [Platform.abbreviations] Spell out 'WSGI' if it's unfamiliar to the audience.
sites/platform/src/languages/python/server.md|146 col 96| [Platform.abbreviations] Spell out 'ASGI' if it's unfamiliar to the audience.
sites/platform/src/languages/python/server.md|146 col 105| [Platform.abbreviations] Spell out 'ASGI' if it's unfamiliar to the audience.
sites/platform/src/languages/python/server.md|251 col 43| [Platform.abbreviations] Spell out 'ASGI' if it's unfamiliar to the audience.
sites/platform/src/languages/python/server.md|369 col 54| [Platform.abbreviations] Spell out 'ASGI' if it's unfamiliar to the audience.
sites/platform/src/languages/python/server.md|369 col 63| [Platform.abbreviations] Spell out 'WSGI' if it's unfamiliar to the audience.
sites/platform/src/languages/elixir.md|21 col 6| [Platform.editorializing] Considering avoiding 'notably' to keep the text more neutral.
sites/platform/src/languages/elixir.md|30 col 252| [Platform.there-start] Try to avoid starting sentences with 'There is'.
sites/platform/src/languages/nodejs/debug.md|18 col 37| [Platform.editorializing] Considering avoiding 'completely' to keep the text more neutral.
sites/platform/src/languages/ruby.md|13 col 10| [Platform.abbreviations] Spell out 'MRI' if it's unfamiliar to the audience.
sites/platform/src/languages/ruby.md|104 col 35| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/languages/ruby.md|258 col 31| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/languages/ruby.md|377 col 122| [Platform.contractions] Feel free to use a contraction instead of 'Could not'
sites/platform/src/languages/nodejs/node-version.md|11 col 1| [Platform.words-to-avoid] Consider using 'so' instead of 'Therefore'. This makes it simpler and clearer.
sites/platform/src/dedicated-gen-2/architecture/deploying.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 15.04
sites/platform/src/dedicated-gen-2/architecture/deploying.md|32 col 26| [Platform.words-to-avoid] Consider using 'about' instead of 'approximately'. This makes it simpler and clearer.
sites/platform/src/dedicated-gen-2/architecture/deploying.md|32 col 64| [Platform.contractions] Feel free to use a contraction instead of 'that is'
sites/platform/src/dedicated-gen-2/architecture/deploying.md|37 col 1| [Platform.first-person] Try to avoid using the first person like 'We'.
sites/platform/src/dedicated-gen-2/architecture/deploying.md|37 col 37| [Platform.contractions] Feel free to use a contraction instead of 'that is'
sites/platform/src/dedicated-gen-2/overview/_index.md|25 col 1| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/dedicated-gen-2/architecture/development.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 15.10
sites/platform/src/dedicated-gen-2/overview/updates-upgrades.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 23.80
sites/platform/src/dedicated-gen-2/overview/updates-upgrades.md|6 col 133| [Platform.latin] Use '' instead of ', etc'.
sites/platform/src/dedicated-gen-2/overview/updates-upgrades.md|8 col 1| [Platform.first-person] Try to avoid using the first person like 'We'.
sites/platform/src/dedicated-gen-2/overview/updates-upgrades.md|8 col 70| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/dedicated-gen-2/overview/updates-upgrades.md|10 col 1| [Platform.first-person] Try to avoid using the first person like 'We'.
sites/platform/src/dedicated-gen-2/overview/updates-upgrades.md|12 col 54| [Platform.latin] Use '' instead of ', etc'.
sites/platform/src/dedicated-gen-2/architecture/options.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 17.14
sites/platform/src/dedicated-gen-2/architecture/options.md|22 col 1| [Platform.max-sentence-length] This sentence has more than 40 words in it. Try making it shorter.
sites/platform/src/dedicated-gen-2/architecture/options.md|22 col 151| [Platform.abbreviations] Spell out 'UAT' if it's unfamiliar to the audience.
sites/platform/src/dedicated-gen-2/architecture/options.md|26 col 35| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/dedicated-gen-2/architecture/options.md|33 col 4| [Platform.abbreviations] Spell out 'SFTP' if it's unfamiliar to the audience.
sites/platform/src/dedicated-gen-2/architecture/options.md|35 col 30| [Platform.abbreviations] Spell out 'SFTP' if it's unfamiliar to the audience.
sites/platform/src/dedicated-gen-2/architecture/options.md|37 col 1| [Platform.there-start] Try to avoid starting sentences with 'There is'.
sites/platform/src/dedicated-gen-2/architecture/options.md|38 col 62| [Platform.abbreviations] Spell out 'SFTP' if it's unfamiliar to the audience.
sites/platform/src/dedicated-gen-2/architecture/options.md|48 col 12| [Platform.editorializing] Considering avoiding 'vast' to keep the text more neutral.
sites/platform/src/dedicated-gen-2/architecture/options.md|49 col 89| [Platform.first-person] Try to avoid using the first person like 'our'.
sites/platform/src/dedicated-gen-2/architecture/options.md|52 col 29| [Platform.latin] Use '' instead of ', etc'.
sites/platform/src/dedicated-gen-2/architecture/options.md|52 col 133| [Platform.first-person] Try to avoid using the first person like 'us'.
sites/platform/src/dedicated-gen-2/architecture/options.md|68 col 1| [Platform.there-start] Try to avoid starting sentences with 'There is'.
sites/platform/src/dedicated-gen-2/architecture/options.md|75 col 1| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/dedicated-gen-2/overview/backups.md|25 col 2| [Platform.first-person] Try to avoid using the first person like 'We'.
sites/platform/src/dedicated-gen-2/overview/backups.md|27 col 79| [Platform.latin] Use '' instead of ', etc'.
sites/platform/src/bestpractices/clean-repository.md|85 col 1| [Platform.words-to-avoid] Consider using 'so' instead of 'Therefore'. This makes it simpler and clearer.
sites/platform/src/bestpractices/clean-repository.md|97 col 51| [Platform.abbreviations] Spell out 'BFG' if it's unfamiliar to the audience.
sites/platform/src/increase-observability/integrate-observability/tideways.md|12 col 132| [Platform.editorializing] Considering avoiding 'mostly' to keep the text more neutral.
sites/platform/src/bestpractices/oneormany.md|81 col 10| [Platform.editorializing] Considering avoiding 'significantly' to keep the text more neutral.
sites/platform/src/bestpractices/oneormany.md|85 col 1| [Platform.words-to-avoid] Consider using 'so' instead of 'Therefore'. This makes it simpler and clearer.
sites/platform/src/bestpractices/oneormany.md|104 col 3| [Platform.there-start] Try to avoid starting sentences with 'There is'.
sites/platform/src/bestpractices/oneormany.md|106 col 27| [Platform.editorializing] Considering avoiding 'relatively' to keep the text more neutral.
sites/platform/src/increase-observability/integrate-observability/new-relic/_index.md|14 col 31| [Platform.first-person] Try to avoid using the first person like 'us'.
sites/platform/src/increase-observability/integrate-observability/new-relic/_index.md|15 col 1| [Platform.first-person] Try to avoid using the first person like 'Our'.
sites/platform/src/increase-observability/integrate-observability/new-relic/_index.md|15 col 18| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/increase-observability/integrate-observability/new-relic/java.md|31 col 42| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/increase-observability/integrate-observability/new-relic/java.md|105 col 26| [Platform.contractions] Feel free to use a contraction instead of 'it is'
sites/platform/src/increase-observability/integrate-observability/new-relic/java.md|105 col 103| [Platform.future] Avoid using 'will'. Stick to the present tense.
sites/platform/src/increase-observability/integrate-observability/blackfire.md|39 col 1| [Platform.words-to-avoid] Consider using 'so' instead of 'Therefore'. This makes it simpler and clearer.
sites/platform/src/increase-observability/metrics/grid.md|24 col 58| [Platform.words-to-avoid] Consider using 'usage' instead of 'utilization'. This makes it simpler and clearer.
sites/platform/src/increase-observability/metrics/grid.md|33 col 56| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/increase-observability/metrics/dedicated-generation-3.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 15.38
sites/platform/src/increase-observability/metrics/_index.md|47 col 3| [Platform.words-to-avoid] Consider using 'so' instead of 'Therefore'. This makes it simpler and clearer.
sites/platform/src/increase-observability/logs/forward-fastly-logs.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 15.25
sites/platform/src/increase-observability/logs/forward-fastly-logs.md|11 col 5| [Platform.words-to-avoid] Consider using 'so' instead of 'therefore'. This makes it simpler and clearer.
sites/platform/src/development/headers.md|23 col 72| [Platform.words-to-avoid] Consider using 'help' instead of 'assist'. This makes it simpler and clearer.
sites/platform/src/development/headers.md|23 col 160| [Platform.contractions] Feel free to use a contraction instead of 'Do not'
sites/platform/src/development/transfer-dedicated.md|26 col 1| [Platform.serial-comma] Use the serial comma in 'To back up your database, adapt and'.
sites/platform/src/development/email.md|149 col 75| [Platform.abbreviations] Spell out 'IMAP' if it's unfamiliar to the audience.
sites/platform/src/development/ssh/_index.md|34 col 53| [Platform.abbreviations] Spell out 'TLS' if it's unfamiliar to the audience.
sites/platform/src/development/ssh/_index.md|165 col 1| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/development/ssh/_index.md|185 col 1| [Platform.serial-comma] Use the serial comma in 'To enhance security, Enterprise and'.
sites/platform/src/development/variables/_index.md|149 col 1| [Platform.serial-comma] Use the serial comma in 'By default, project and'.
sites/platform/src/development/variables/use-variables.md|328 col 9| [Platform.editorializing] Considering avoiding 'mostly' to keep the text more neutral.
sites/platform/src/development/variables/use-variables.md|355 col 115| [Platform.editorializing] Considering avoiding 'essentially' to keep the text more neutral.
sites/platform/src/development/variables/use-variables.md|355 col 131| [Platform.abbreviations] Spell out 'SHA' if it's unfamiliar to the audience.
sites/platform/src/development/ssh/troubleshoot-ssh.md|11 col 1| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/development/ssh/troubleshoot-ssh.md|86 col 69| [Platform.contractions] Feel free to use a contraction instead of 'could not'
sites/platform/src/development/ssh/troubleshoot-ssh.md|113 col 12| [Platform.first-person] Try to avoid using the first person like 'My'.
sites/platform/src/development/local/untethered.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 17.62
sites/platform/src/development/local/untethered.md|10 col 21| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'however'. This makes it simpler and clearer.
sites/platform/src/development/local/docksal.md|75 col 26| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/development/local/lando.md|8 col 113| [Platform.abbreviations] Spell out 'LAMP' if it's unfamiliar to the audience.
sites/platform/src/development/local/lando.md|8 col 119| [Platform.abbreviations] Spell out 'LEMP' if it's unfamiliar to the audience.
sites/platform/src/development/local/lando.md|8 col 125| [Platform.abbreviations] Spell out 'MEAN' if it's unfamiliar to the audience.
sites/platform/src/development/local/lando.md|9 col 151| [Platform.abbreviations] Spell out 'KMS' if it's unfamiliar to the audience.
sites/platform/src/development/sanitize-db/_index.md|16 col 1| [Platform.serial-comma] Use the serial comma in 'Depending on your processes, internal or'.
sites/platform/src/development/troubleshoot.md|12 col 1| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/development/troubleshoot.md|13 col 23| [Platform.abbreviations] Spell out 'TLS' if it's unfamiliar to the audience.
sites/platform/src/development/troubleshoot.md|151 col 1| [Platform.words-to-avoid] Consider using 'to' instead of 'to be able to'. This makes it simpler and clearer.
sites/platform/src/development/troubleshoot.md|154 col 1| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/development/sanitize-db/postgresql.md|26 col 42| [Platform.abbreviations] Spell out 'PII' if it's unfamiliar to the audience.
sites/platform/src/development/sanitize-db/postgresql-symfony.md|27 col 49| [Platform.abbreviations] Spell out 'PII' if it's unfamiliar to the audience.
sites/platform/src/development/sanitize-db/postgresql-symfony.md|100 col 62| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/development/sanitize-db/postgresql-symfony.md|112 col 62| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/development/sanitize-db/postgresql-symfony.md|250 col 33| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/development/file-transfer.md|10 col 1| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/development/file-transfer.md|144 col 22| [Platform.editorializing] Considering avoiding 'very' to keep the text more neutral.
sites/platform/src/development/submodules.md|106 col 74| [Platform.first-person] Try to avoid using the first person like 'our'.
sites/platform/src/development/submodules.md|107 col 13| [Platform.first-person] Try to avoid using the first person like 'our'.
sites/platform/src/development/submodules.md|134 col 55| [Platform.contractions] Feel free to use a contraction instead of 'is not'
sites/platform/src/development/deploy-button.md|1 col 1| [Platform.average-sentence-length] Try to keep your sentences short. Aim for up to 15 words per sentence. You are currently at: 16.36
sites/platform/src/development/deploy-button.md|6 col 1| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'However'. This makes it simpler and clearer.
sites/platform/src/development/deploy-button.md|8 col 1| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/development/deploy-button.md|9 col 46| [Platform.contractions] Feel free to use a contraction instead of 'they are'
sites/platform/src/development/deploy-button.md|32 col 1| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'however'. This makes it simpler and clearer.
sites/platform/src/development/deploy-button.md|33 col 1| [Platform.max-sentence-length] This sentence has more than 40 words in it. Try making it shorter.
sites/platform/src/development/deploy-button.md|75 col 71| [Platform.abbreviations] Spell out 'NOT' if it's unfamiliar to the audience.
sites/platform/src/development/regions.md|15 col 25| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/development/regions.md|15 col 54| [Platform.first-person] Try to avoid using the first person like 'our'.
sites/platform/src/development/regions.md|15 col 115| [Platform.first-person] Try to avoid using the first person like 'us'.
sites/platform/src/development/regions.md|15 col 119| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/development/regions.md|16 col 54| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/development/regions.md|16 col 171| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/development/regions.md|21 col 64| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/development/regions.md|21 col 101| [Platform.abbreviations] Spell out 'IEA' if it's unfamiliar to the audience.
sites/platform/src/development/regions.md|21 col 116| [Platform.first-person] Try to avoid using the first person like 'our'.
sites/platform/src/development/regions.md|21 col 279| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/development/regions.md|34 col 20| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/tutorials/dependency-updates.md|211 col 64| [Platform.words-to-avoid] Consider using 'so' instead of 'therefore'. This makes it simpler and clearer.
sites/platform/src/tutorials/dependency-updates.md|241 col 16| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/define-routes/redirects.md|4 col 106| [Platform.contractions] Feel free to use a contraction instead of 'do not'
sites/platform/src/define-routes/redirects.md|9 col 100| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/define-routes/redirects.md|9 col 112| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/define-routes/redirects.md|13 col 45| [Platform.editorializing] Considering avoiding 'very' to keep the text more neutral.
sites/platform/src/define-routes/redirects.md|49 col 62| [Platform.abbreviations] Spell out 'PCRE' if it's unfamiliar to the audience.
sites/platform/src/define-routes/redirects.md|86 col 7| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/define-routes/redirects.md|111 col 18| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/define-routes/redirects.md|114 col 101| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/define-routes/redirects.md|127 col 18| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/define-routes/redirects.md|131 col 100| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/define-routes/redirects.md|140 col 21| [Platform.contractions] Feel free to use a contraction instead of 'does not'
sites/platform/src/define-routes/proxy.md|9 col 3| [Platform.contractions] Feel free to use a contraction instead of 'Do not'
sites/platform/src/define-routes/ssi.md|13 col 19| [Platform.abbreviations] Spell out 'SSI' if it's unfamiliar to the audience.
sites/platform/src/define-routes/ssi.md|49 col 13| [Platform.abbreviations] Spell out 'SSI' if it's unfamiliar to the audience.
sites/platform/src/define-routes/ssi.md|52 col 31| [Platform.abbreviations] Spell out 'SSI' if it's unfamiliar to the audience.
sites/platform/src/define-routes/ssi.md|90 col 13| [Platform.abbreviations] Spell out 'SSI' if it's unfamiliar to the audience.
sites/platform/src/define-routes/_index.md|252 col 31| [Platform.abbreviations] Spell out 'TLS' if it's unfamiliar to the audience.
sites/platform/src/define-routes/_index.md|402 col 56| [Platform.abbreviations] Spell out 'TLS' if it's unfamiliar to the audience.
sites/platform/src/define-routes/_index.md|434 col 76| [Platform.abbreviations] Spell out 'SSI' if it's unfamiliar to the audience.
sites/platform/src/define-routes/_index.md|479 col 1| [Platform.contractions] Feel free to use a contraction instead of 'they are'
sites/platform/src/define-routes/_index.md|479 col 10| [Platform.words-to-avoid] Consider using 'so' instead of 'therefore'. This makes it simpler and clearer.
sites/platform/src/define-routes/cache.md|28 col 39| [Platform.words-to-avoid] Consider using 'but (or nothing)' instead of 'however'. This makes it simpler and clearer.
sites/platform/src/define-routes/cache.md|66 col 1| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/define-routes/cache.md|109 col 87| [Platform.editorializing] Considering avoiding 'actually' to keep the text more neutral.
sites/platform/src/define-routes/cache.md|177 col 62| [Platform.abbreviations] Spell out 'PCRE' if it's unfamiliar to the audience.
sites/platform/src/define-routes/cache.md|199 col 61| [Platform.contractions] Feel free to use a contraction instead of 'that is'
sites/platform/src/define-routes/cache.md|208 col 8| [Platform.contractions] Feel free to use a contraction instead of 'Do not'
sites/platform/src/define-routes/cache.md|273 col 142| [Platform.latin] Use 'that is' instead of 'i.e.'.
sites/platform/src/define-routes/https.md|151 col 45| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/define-routes/https.md|155 col 55| [Platform.link-text] Try to use meaningful text for links.
sites/platform/src/guides/quarkus/deploy/customize.md|9 col 182| [Platform.there-start] Try to avoid starting sentences with 'There are'.
sites/platform/src/guides/quarkus/deploy/customize.md|9 col 188| [Platform.editorializing] Considering avoiding 'are a number' to keep the text more neutral.
sites/platform/src/guides/quarkus/deploy/customize.md|33 col 272| [Platform.there-start] Try to avoid starting sentences with 'It is'.
sites/platform/src/guides/quarkus/deploy/customize.md|33 col 272| [Platform.contractions] Feel free to use a contraction instead of 'It is'
sites/platform/src/guides/quarkus/deploy/customize.md|52 col 25| [Platform.first-person] Try to avoid using the first person like 'we'.
sites/platform/src/guides/quarkus/deploy/customize.md|54 col 11| [Platform.first-person] Try to avoid using the first person like 'us'.
sites/platform/src/guides/quarkus/deploy/customize.md|62 col 42| [Platform.please] Try to avoid using 'please'.
sites/platform/src/guides/quarkus/deploy/next-steps.md|9 col 473| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/guides/quarkus/deploy/next-steps.md|14 col 4| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/guides/quarkus/deploy/configure.md|15 col 20| [Platform.future] Avoid using ''ll'. Stick to the present tense.
sites/platform/src/guides/quarkus/panache.md|10 col 11| [Platform.abbreviations] Spell out 'ORM' if it's unfamiliar to the audience.
sites/platform/src/guides/quarkus/panache.md|10 col 20| [Platform.abbreviations] Spell out 'JPA' if it's unfamiliar to the audience.
sites/platform/src/guides/quarkus/panache.md|10 col 186| [Platform.abbreviations] Spell out 'ORM' if it's unfamiliar to the audience.
sites/platform/src/guides/quarkus/panache.md|12 col 116| [Platform.words-to-avoid] Consider using 'you need to' instead of 'it is necessary to'. This makes it simpler and clearer.
... (Too many findings. Dropped some findings)

Annotations

Check warning on line 8 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L8

[Platform.first-person] Try to avoid using the first person like 'we'.
Raw output
{"message": "[Platform.first-person] Try to avoid using the first person like 'we'.", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 8, "column": 39}}}, "severity": "WARNING"}

Check warning on line 8 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L8

[Platform.future] Avoid using 'will'. Stick to the present tense.
Raw output
{"message": "[Platform.future] Avoid using 'will'. Stick to the present tense.", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 8, "column": 186}}}, "severity": "WARNING"}

Check notice on line 26 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L26

[Platform.there-start] Try to avoid starting sentences with 'It is'.
Raw output
{"message": "[Platform.there-start] Try to avoid starting sentences with 'It is'.", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 26, "column": 99}}}, "severity": "INFO"}

Check notice on line 26 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L26

[Platform.contractions] Feel free to use a contraction instead of 'It is'
Raw output
{"message": "[Platform.contractions] Feel free to use a contraction instead of 'It is'", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 26, "column": 99}}}, "severity": "INFO"}

Check warning on line 33 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L33

[Platform.first-person] Try to avoid using the first person like 'my'.
Raw output
{"message": "[Platform.first-person] Try to avoid using the first person like 'my'.", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 33, "column": 26}}}, "severity": "WARNING"}

Check warning on line 33 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L33

[Platform.first-person] Try to avoid using the first person like ' I '.
Raw output
{"message": "[Platform.first-person] Try to avoid using the first person like ' I '.", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 33, "column": 46}}}, "severity": "WARNING"}

Check warning on line 43 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L43

[Platform.latin] Use '' instead of ', etc'.
Raw output
{"message": "[Platform.latin] Use '' instead of ', etc'.", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 43, "column": 80}}}, "severity": "WARNING"}

Check warning on line 44 in sites/platform/src/_index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/_index.md#L44

[Platform.latin] Use '' instead of ', etc'.
Raw output
{"message": "[Platform.latin] Use '' instead of ', etc'.", "location": {"path": "sites/platform/src/_index.md", "range": {"start": {"line": 44, "column": 180}}}, "severity": "WARNING"}

Check warning on line 131 in sites/platform/src/add-services/opensearch.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/add-services/opensearch.md#L131

[Platform.link-text] Try to use meaningful text for links.
Raw output
{"message": "[Platform.link-text] Try to use meaningful text for links.", "location": {"path": "sites/platform/src/add-services/opensearch.md", "range": {"start": {"line": 131, "column": 68}}}, "severity": "WARNING"}

Check warning on line 186 in sites/platform/src/add-services/elasticsearch.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sites/platform/src/add-services/elasticsearch.md#L186

[Platform.link-text] Try to use meaningful text for links.
Raw output
{"message": "[Platform.link-text] Try to use meaningful text for links.", "location": {"path": "sites/platform/src/add-services/elasticsearch.md", "range": {"start": {"line": 186, "column": 68}}}, "severity": "WARNING"}