Skip to content

Commit

Permalink
Fixed documentation spell checking and fixed spelling.
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexSkrypnyk committed Jan 13, 2024
1 parent 4b30d20 commit 0565550
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 12 deletions.
12 changes: 12 additions & 0 deletions .drevops/docs/.utils/.aspell.en.pws
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ PHPMD
PHPStan
PHPUnit
PRs
PSR
Packagist
PhpStorm
Profiler
Expand Down Expand Up @@ -80,10 +81,13 @@ Upgradable
VueJS
WIP
Webhook
Webserver
Xdebug
YAML
YOURORG
YOURSITE
acquia
amazee
amazeeio
assignees
autotesting
Expand All @@ -95,10 +99,12 @@ changelog
checkstyle
codebase
commandfiles
config
contrib
cron
customisations
dev
docblock
drush
env
fe
Expand All @@ -116,21 +122,27 @@ md
newrelic
npm
onboarding
overcomplicated
php
phpcs
pre
readme
roadmap
runtime
runtime's
sanitization
scaffolded
scalability
sql
suboptimal
toc
tokenizes
toolset
txt
uat
uncommented
unmapped
untrusted
upgradable
url
webhook
Expand Down
16 changes: 8 additions & 8 deletions .drevops/docs/.utils/lint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@
set -eu
[ "${DREVOPS_DEBUG-}" = "1" ] && set -x

CUR_DIR="$(dirname "${BASH_SOURCE[0]}")"
cur_dir="$(dirname "${BASH_SOURCE[0]}")"

DICTIONARY="${CUR_DIR}/.aspell.en.pws"
dictionary="${cur_dir}/.aspell.en.pws"

targets=()
while IFS= read -r -d $'\0'; do
targets+=("${REPLY}")
done < <(
find \
"${CUR_DIR}/.." \
"${cur_dir}/.." \
-type f \
\( -name "*.md" \) \
-not -path "*vendor*" -not -path "*node_modules*" \
-print0
)

echo -n "==> Validating dictionary."
if head -1 "${DICTIONARY}" | grep -q "personal_ws-1.1 en 28"; then
echo -n "==> Validating dictionary... "
if head -1 "${dictionary}" | grep -q "personal_ws-1.1 en 28"; then
echo "OK"
else
echo "ERROR: invalid dictionary format"
Expand All @@ -45,14 +45,14 @@ for file in "${targets[@]}"; do
# Remove HTML.
sed -E 's/<([^<]+)>//g' |
# Remove code blocks.
sed -n '/\`\`\`/,/\`\`\`/ !p' |
sed '/^[[:space:]]*```/,/^[[:space:]]*```/d' |
# Remove inline code.
sed -n '/\`/,/\`/ !p' |
sed 's/`[^`]*`//g' |
# Remove anchors.
sed -E 's/\[.+\]\([^\)]+\)//g' |
# Remove links.
sed -E 's/http(s)?:\/\/([^ ]+)//g' |
aspell --lang=en --encoding=utf-8 --personal="${DICTIONARY}" list | tee /dev/stderr | [ "$(wc -l)" -eq 0 ]
aspell --lang=en --encoding=utf-8 --personal="${dictionary}" list | tee /dev/stderr | [ "$(wc -l)" -eq 0 ]

if [ "$?" -ne 0 ]; then
exit 1
Expand Down
2 changes: 1 addition & 1 deletion .drevops/docs/.utils/terminalizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ npm install -g terminalizer
terminalizer record <recording-name>
```

2. Update produced YML file with settings from `example.yml`.
2. Update produced YAML file with settings from `example.yml`.

3. Render
```shell
Expand Down
2 changes: 1 addition & 1 deletion .drevops/docs/content/workflows/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ variable as a comma-separated list of one or multiple supported deployment types

After setting up the deployment integration, you can begin using it by adding
the `$DREVOPS_DEPLOY_PROCEED` variable with a value of `1` in the CircleCI user
interface. This variable is used as a failsafe to prevent accidental
interface. This variable is used as a fail-safe to prevent accidental
deployments while setting up DrevOps.

## Using deployments
Expand Down
2 changes: 1 addition & 1 deletion .drevops/docs/content/workflows/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ Defined in: `ACQUIA ENVIRONMENT`

Overwrite existing database if it exists.

Usually set to `0` in deployed environments and can be temporary set to `1` for<br />a specific deployment.<br />Set this to `1` in .env.local to override when developing localy.
Usually set to `0` in deployed environments and can be temporary set to `1` for<br />a specific deployment.<br />Set this to `1` in .env.local to override when developing locally.

Default value: `UNDEFINED`

Expand Down
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ DREVOPS_PROVISION_USE_PROFILE=0
#
# Usually set to 0 in deployed environments and can be temporary set to 1 for
# a specific deployment.
# Set this to 1 in .env.local to override when developing localy.
# Set this to 1 in .env.local to override when developing locally.
DREVOPS_PROVISION_OVERRIDE_DB=0

# Skip database sanitization.
Expand Down

0 comments on commit 0565550

Please sign in to comment.