Skip to content

Commit

Permalink
t7
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexSkrypnyk committed Aug 31, 2024
1 parent 9c6925c commit 9d3afaf
Show file tree
Hide file tree
Showing 21 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .gitignore.artifact
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/contributing/maintenance/scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions .vortex/docs/content/drupal/composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/drupal/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/getting-started/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/ahoy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/behat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions .vortex/docs/content/tools/doctor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/git-artifact.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/phpcs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/phpmd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/phpstan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/phpunit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/rector.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/tools/xdebug.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/tests/bats/_helper.bash
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions .vortex/tests/bats/install.initial.bats
Original file line number Diff line number Diff line change
Expand Up @@ -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}\""

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .vortex/tests/bats/install.parameters.bats
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

1 comment on commit 9d3afaf

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.