From 9d3afaf61eb69ba23ea459ea1772f798390739a3 Mon Sep 17 00:00:00 2001 From: Alex Skrypnyk Date: Sat, 31 Aug 2024 22:23:19 +1000 Subject: [PATCH] t7 --- .gitignore.artifact | 2 +- .../docs/content/contributing/maintenance/documentation.mdx | 2 +- .vortex/docs/content/contributing/maintenance/scripts.mdx | 2 +- .vortex/docs/content/drupal/composer.mdx | 6 +++--- .vortex/docs/content/drupal/settings.mdx | 2 +- .vortex/docs/content/getting-started/architecture.mdx | 2 +- .vortex/docs/content/tools/README.mdx | 2 +- .vortex/docs/content/tools/ahoy.mdx | 2 +- .vortex/docs/content/tools/behat.mdx | 2 +- .vortex/docs/content/tools/doctor.mdx | 4 ++-- .vortex/docs/content/tools/git-artifact.mdx | 2 +- .vortex/docs/content/tools/phpcs.mdx | 2 +- .vortex/docs/content/tools/phpmd.mdx | 2 +- .vortex/docs/content/tools/phpstan.mdx | 2 +- .vortex/docs/content/tools/phpunit.mdx | 2 +- .vortex/docs/content/tools/rector.mdx | 2 +- .vortex/docs/content/tools/xdebug.mdx | 2 +- .vortex/tests/bats/_helper.bash | 2 +- .vortex/tests/bats/install.initial.bats | 6 +++--- .vortex/tests/bats/install.parameters.bats | 2 +- README.md | 2 +- 21 files changed, 26 insertions(+), 26 deletions(-) diff --git a/.gitignore.artifact b/.gitignore.artifact index f6544719a..be0f30645 100644 --- a/.gitignore.artifact +++ b/.gitignore.artifact @@ -10,7 +10,7 @@ !composer.json !.env -# Do not ignore webroot (manage Drupal_Scaffold files using the composer.json) +# Do not ignore webroot (manage Drupal Scaffold files using the composer.json) !web # But ignore content files and test artifacts. web/sites/default/files diff --git a/.vortex/docs/content/contributing/maintenance/documentation.mdx b/.vortex/docs/content/contributing/maintenance/documentation.mdx index 64d0703fa..04673f000 100644 --- a/.vortex/docs/content/contributing/maintenance/documentation.mdx +++ b/.vortex/docs/content/contributing/maintenance/documentation.mdx @@ -48,7 +48,7 @@ An automated CI build publishes this documentation. - on tag, publishes to https://docs.drevops.com/ - on every commit to a branch that contains `release-docs` string publishes to https://docs.drevops.com/ -- on every push to `develop`, publishes to development version of documentation https://drevops-vortex-docs.netlify.app +- on every push to `develop`, publishes to development version of documentation https://vortex-docs.netlify.app - on every push or tag, publishes to the temporary version of documentation with a link added to the PR as a comment. ## Consumer site documentation diff --git a/.vortex/docs/content/contributing/maintenance/scripts.mdx b/.vortex/docs/content/contributing/maintenance/scripts.mdx index 1c55e44cc..065601503 100644 --- a/.vortex/docs/content/contributing/maintenance/scripts.mdx +++ b/.vortex/docs/content/contributing/maintenance/scripts.mdx @@ -82,7 +82,7 @@ Follow these guidelines when creating or updating **Vortex** variables. 1. Local variables MUST be in lowercase, and global variables MUST be in uppercase. -2. All **Vortex** variables MUST start with `VORTEX_` to separate DrevOps from +2. All **Vortex** variables MUST start with `VORTEX_` to separate Vortex from third-party variables. 3. Global variables MAY be re-used as-is across scripts. For instance, the diff --git a/.vortex/docs/content/drupal/composer.mdx b/.vortex/docs/content/drupal/composer.mdx index f90e71e81..977d00d8a 100644 --- a/.vortex/docs/content/drupal/composer.mdx +++ b/.vortex/docs/content/drupal/composer.mdx @@ -7,7 +7,7 @@ sidebar_position: 1 [Composer](https://getcomposer.org/) is a dependency manager for PHP projects, including Drupal. It allows you to declare the libraries your project depends on and manages them for you. -Vortex comes with a pre-configured `composer.json` file based on +**Vortex** comes with a pre-configured `composer.json` file based on the [Drupal Composer project](https://github.com/drupal-composer/drupal-project), extended to support additional features and tools. @@ -120,7 +120,7 @@ specifies the essential packages and libraries your project needs. and stability, as these dependencies are maintained and curated by the Drupal community. - [`drupal/core-composer-scaffold`](https://www.drupal.org/docs/develop/using-composer/using-drupals-composer-scaffold): - Allows downloading and placing **Drupal_Scaffold** files (like `index.php`, + Allows downloading and placing **Drupal Scaffold** files (like `index.php`, `update.php`, etc.) from the `drupal/core` project into their desired location inside the web root. - [`drush/drush`](https://github.com/drush-ops/drush): A command-line shell and @@ -274,7 +274,7 @@ needs and structure of your Drupal project. - `locations`: Specifies the location of the web root (the directory containing the `index.php` file). - `file-mapping`: Determines which files are managed by the scaffold process. - Vortex comes with sensible defaults, but you can customize this section to + **Vortex** comes with sensible defaults, but you can customize this section to suit your needs. - [`installer-paths`](https://getcomposer.org/doc/faqs/how-do-i-install-a-package-to-a-custom-path-for-my-framework.md): Defines custom installation paths for various types of packages like Drupal diff --git a/.vortex/docs/content/drupal/settings.mdx b/.vortex/docs/content/drupal/settings.mdx index c0b6c47b1..b0af8f63f 100644 --- a/.vortex/docs/content/drupal/settings.mdx +++ b/.vortex/docs/content/drupal/settings.mdx @@ -16,7 +16,7 @@ the settings apply correctly per environment. These tests are supposed to be maintained within your project, ensuring that settings activated by specific environments and environment variables are applied accurately. -The default **Drupal_Scaffold**'s [`default.settings.php`](https://github.com/drevops/scaffold/blob/develop/web/sites/default/default.settings.php) +The default **Drupal Scaffold**'s [`default.settings.php`](https://github.com/drevops/scaffold/blob/develop/web/sites/default/default.settings.php) and [`default.services.yml`](https://github.com/drevops/scaffold/blob/develop/web/sites/default/default.services.yml) files are also provided if you choose to use them instead. diff --git a/.vortex/docs/content/getting-started/architecture.mdx b/.vortex/docs/content/getting-started/architecture.mdx index 4fa8ee483..ccae1421b 100644 --- a/.vortex/docs/content/getting-started/architecture.mdx +++ b/.vortex/docs/content/getting-started/architecture.mdx @@ -56,7 +56,7 @@ with addition of several configuration files and directories. ├── scripts # Composer, Vortex and custom project scripts. │ ├── composer # Composer scripts. │ ├── custom # Custom project scripts. -│ └── drevops # Vortex workflow scripts. +│ └── vortex # Vortex workflow scripts. ├── tests # Integration and configuration tests. │ ├── behat # Behat BDD tests. │ └── phpunit # Configuration unit tests diff --git a/.vortex/docs/content/tools/README.mdx b/.vortex/docs/content/tools/README.mdx index 504e536fa..b828ede96 100644 --- a/.vortex/docs/content/tools/README.mdx +++ b/.vortex/docs/content/tools/README.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 # Tools -Vortex comes with a set of tools to help you develop and maintain your Drupal +**Vortex** comes with a set of tools to help you develop and maintain your Drupal project. The tools have their own configuration files with sensible defaults to make them work diff --git a/.vortex/docs/content/tools/ahoy.mdx b/.vortex/docs/content/tools/ahoy.mdx index ea314f5fd..2d4182071 100644 --- a/.vortex/docs/content/tools/ahoy.mdx +++ b/.vortex/docs/content/tools/ahoy.mdx @@ -10,7 +10,7 @@ with zero code and dependencies. Usually, Ahoy is used to wrap the commands to make the development workflow consistent and easy to use. -Vortex comes with [pre-configured Ahoy file](https://github.com/drevops/scaffold/blob/develop/.ahoy.yml) that has +**Vortex** comes with [pre-configured Ahoy file](https://github.com/drevops/scaffold/blob/develop/.ahoy.yml) that has commands wrapped around the most common tasks: - Working with containers diff --git a/.vortex/docs/content/tools/behat.mdx b/.vortex/docs/content/tools/behat.mdx index 2c3339136..395c9c827 100644 --- a/.vortex/docs/content/tools/behat.mdx +++ b/.vortex/docs/content/tools/behat.mdx @@ -6,7 +6,7 @@ https://docs.behat.org/en/latest/user_guide.html > A php framework for auto-testing your business expectations. -Vortex comes with [pre-configured Behat profiles](https://github.com/drevops/scaffold/blob/develop/behat.yml) for Drupal projects. +**Vortex** comes with [pre-configured Behat profiles](https://github.com/drevops/scaffold/blob/develop/behat.yml) for Drupal projects. ## Usage diff --git a/.vortex/docs/content/tools/doctor.mdx b/.vortex/docs/content/tools/doctor.mdx index c89fe74d7..65d6287fd 100644 --- a/.vortex/docs/content/tools/doctor.mdx +++ b/.vortex/docs/content/tools/doctor.mdx @@ -31,8 +31,8 @@ $ ahoy doctor [ OK ] Pygmy is running. [ OK ] All containers are running [ OK ] SSH key is available within CLI container. -[ OK ] Web server is running and accessible at http://drevops.docker.amazee.io. -[ OK ] Bootstrapped website at http://drevops.docker.amazee.io. +[ OK ] Web server is running and accessible at http://vortex.docker.amazee.io. +[ OK ] Bootstrapped website at http://vortex.docker.amazee.io. [ OK ] All required checks have passed. ``` diff --git a/.vortex/docs/content/tools/git-artifact.mdx b/.vortex/docs/content/tools/git-artifact.mdx index 963a5539d..500c1eb75 100644 --- a/.vortex/docs/content/tools/git-artifact.mdx +++ b/.vortex/docs/content/tools/git-artifact.mdx @@ -10,7 +10,7 @@ tool streamlines that process: it uses a `.gitignore.artifact` file to control which files get transferred, and overwrites the destination repository's history with each push, while preserving the source history. -Vortex comes +**Vortex** comes with [pre-configured `.gitignore.artifact`](https://github.com/drevops/scaffold/blob/develop/.gitignore.artifact) file and [deployment script](https://github.com/drevops/scaffold/blob/develop/scripts/vortex/deploy-artifact.sh) to build the artifact in CI and push it to the remote repository in Acquia. diff --git a/.vortex/docs/content/tools/phpcs.mdx b/.vortex/docs/content/tools/phpcs.mdx index ea7114c18..95a5977d9 100644 --- a/.vortex/docs/content/tools/phpcs.mdx +++ b/.vortex/docs/content/tools/phpcs.mdx @@ -12,7 +12,7 @@ https://github.com/squizlabs/PHP_CodeSniffer > violations. PHP_CodeSniffer is an essential development tool that ensures your > code remains clean and consistent. -Vortex comes with [pre-configured PHPCS ruleset](https://github.com/drevops/scaffold/blob/develop/phpcs.xml) for Drupal projects. +**Vortex** comes with [pre-configured PHPCS ruleset](https://github.com/drevops/scaffold/blob/develop/phpcs.xml) for Drupal projects. ## Usage diff --git a/.vortex/docs/content/tools/phpmd.mdx b/.vortex/docs/content/tools/phpmd.mdx index 75368119e..274909a29 100644 --- a/.vortex/docs/content/tools/phpmd.mdx +++ b/.vortex/docs/content/tools/phpmd.mdx @@ -14,7 +14,7 @@ https://github.com/phpmd/phpmd > - Overcomplicated expressions > - Unused parameters, methods, properties -Vortex comes with [pre-configured PHPMD ruleset](https://github.com/drevops/scaffold/blob/develop/phpmd.xml) +**Vortex** comes with [pre-configured PHPMD ruleset](https://github.com/drevops/scaffold/blob/develop/phpmd.xml) for Drupal projects. ## Usage diff --git a/.vortex/docs/content/tools/phpstan.mdx b/.vortex/docs/content/tools/phpstan.mdx index 420ae1d1c..1e0127aea 100644 --- a/.vortex/docs/content/tools/phpstan.mdx +++ b/.vortex/docs/content/tools/phpstan.mdx @@ -13,7 +13,7 @@ https://phpstan.org/user-guide/getting-started > line > of the code can be checked before you run the actual line. -Vortex comes with [pre-configured PHPStan ruleset](https://github.com/drevops/scaffold/blob/develop/phpstan.neon) +**Vortex** comes with [pre-configured PHPStan ruleset](https://github.com/drevops/scaffold/blob/develop/phpstan.neon) for Drupal projects. diff --git a/.vortex/docs/content/tools/phpunit.mdx b/.vortex/docs/content/tools/phpunit.mdx index 64bd99537..a5a90745c 100644 --- a/.vortex/docs/content/tools/phpunit.mdx +++ b/.vortex/docs/content/tools/phpunit.mdx @@ -8,7 +8,7 @@ https://github.com/sebastianbergmann/phpunit/ > PHPUnit is a programmer-oriented testing framework for PHP. -Vortex comes with [pre-configured PHPCS ruleset](https://github.com/drevops/scaffold/blob/develop/phpunit.xml) for Drupal projects. +**Vortex** comes with [pre-configured PHPCS ruleset](https://github.com/drevops/scaffold/blob/develop/phpunit.xml) for Drupal projects. ## Usage diff --git a/.vortex/docs/content/tools/rector.mdx b/.vortex/docs/content/tools/rector.mdx index 376d09d7d..d8ff9a724 100644 --- a/.vortex/docs/content/tools/rector.mdx +++ b/.vortex/docs/content/tools/rector.mdx @@ -8,7 +8,7 @@ https://github.com/rectorphp/rector > Rector instantly upgrades and refactors the PHP code of your application. -Vortex comes with [pre-configured Rector configuration](https://github.com/drevops/scaffold/blob/develop/rector.php) +**Vortex** comes with [pre-configured Rector configuration](https://github.com/drevops/scaffold/blob/develop/rector.php) for Drupal projects. The configuration is based on the configuration provided by [Drupal Rector](https://github.com/palantirnet/drupal-rector). diff --git a/.vortex/docs/content/tools/xdebug.mdx b/.vortex/docs/content/tools/xdebug.mdx index 4958ff0bd..5ceb6ae16 100644 --- a/.vortex/docs/content/tools/xdebug.mdx +++ b/.vortex/docs/content/tools/xdebug.mdx @@ -9,7 +9,7 @@ https://xdebug.org/ > Xdebug is an extension for PHP, and provides a range of features to improve > the PHP development experience. -Vortex comes with Xdebug pre-installed and configured for local development +**Vortex** comes with Xdebug pre-installed and configured for local development thanks to [Lagoon images](https://github.com/uselagoon/lagoon-images). Xdebug is also configured to work in coverage mode, allowing to run tests with diff --git a/.vortex/tests/bats/_helper.bash b/.vortex/tests/bats/_helper.bash index 12aff2871..ad4ba99cd 100644 --- a/.vortex/tests/bats/_helper.bash +++ b/.vortex/tests/bats/_helper.bash @@ -42,7 +42,7 @@ setup() { export BATS_LIB_PATH="${BATS_TEST_DIRNAME}/../node_modules" # Load 'bats-helpers' library. - ASSERT_DIR_EXCLUDE=("drevops" "vortex" ".data") + ASSERT_DIR_EXCLUDE=("vortex" ".data") export ASSERT_DIR_EXCLUDE bats_load_library bats-helpers diff --git a/.vortex/tests/bats/install.initial.bats b/.vortex/tests/bats/install.initial.bats index c9a89cb0c..b2464aaf5 100644 --- a/.vortex/tests/bats/install.initial.bats +++ b/.vortex/tests/bats/install.initial.bats @@ -76,7 +76,7 @@ load _helper.bash echo VORTEX_INSTALL_COMMIT="${commit1}" >>.env run_installer_quiet assert_git_repo - assert_output_contains "This will install Vortex scaffold into your project at commit" + assert_output_contains "This will install Vortex into your project at commit" assert_output_contains "Downloading Vortex" assert_output_contains "at ref \"${commit1}\"" @@ -161,7 +161,7 @@ load _helper.bash @test "Install into empty directory: quiet; should NOT show that Vortex was previously installed" { output=$(run_installer_quiet) assert_output_contains "WELCOME TO VORTEX QUIET INSTALLER" - assert_output_not_contains "It looks like Vortex scaffold is already installed into this project" + assert_output_not_contains "It looks like Vortex is already installed into this project" assert_files_present assert_git_repo @@ -193,7 +193,7 @@ load _helper.bash ) output=$(run_installer_interactive "${answers[@]}") assert_output_contains "WELCOME TO VORTEX INTERACTIVE INSTALLER" - assert_output_not_contains "It looks like Vortex scaffold is already installed into this project" + assert_output_not_contains "It looks like Vortex is already installed into this project" assert_files_present assert_git_repo diff --git a/.vortex/tests/bats/install.parameters.bats b/.vortex/tests/bats/install.parameters.bats index 52405533d..8ed68a8e1 100644 --- a/.vortex/tests/bats/install.parameters.bats +++ b/.vortex/tests/bats/install.parameters.bats @@ -353,7 +353,7 @@ load _helper.bash output=$(run_installer_interactive "${answers[@]}") assert_output_contains "WELCOME TO VORTEX INTERACTIVE INSTALLER" - assert_output_contains "It looks like Vortex scaffold is already installed into this project." + assert_output_contains "It looks like Vortex is already installed into this project." assert_output_contains "Aborting project installation. No files were changed" # Note that user input takes precedence over discovered values. diff --git a/README.md b/README.md index 5384d2384..c004905ad 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ The documentation is authored within this repository in the `.vortex/docs` direc It is published to [https://docs.drevops.com](https://docs.drevops.com) on Vortex release. -Development version of the documentation is available at [https://drevops-vortex-docs.netlify.app/](https://drevops-vortex-docs.netlify.app/). +Development version of the documentation is available at [https://vortex-docs.netlify.app/](https://vortex-docs.netlify.app/). ## Support