Skip to content

Commit 5588be5

Browse files
committed
Updated settings.php and documentation.
1 parent 2c19156 commit 5588be5

File tree

151 files changed

+2283
-1137
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+2283
-1137
lines changed

.ahoy.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ commands:
197197
usage: Lint front-end code.
198198
cmd: |
199199
ahoy cli vendor/bin/twig-cs-fixer lint
200-
ahoy cli "npm run --prefix \${WEBROOT}/themes/custom/\${DRUPAL_THEME} lint"
200+
ahoy cli "yarn run --cwd=\${WEBROOT}/themes/custom/\${DRUPAL_THEME} lint"
201201
#;> DRUPAL_THEME
202202

203203
lint-tests:
@@ -220,7 +220,7 @@ commands:
220220
usage: Fix lint issues of front-end code.
221221
cmd: |
222222
ahoy cli vendor/bin/twig-cs-fixer lint --fix
223-
ahoy cli "npm run --prefix \${WEBROOT}/themes/custom/\${DRUPAL_THEME} lint-fix"
223+
ahoy cli "yarn run --cwd=\${WEBROOT}/themes/custom/\${DRUPAL_THEME} lint-fix"
224224
#;> DRUPAL_THEME
225225

226226
test:
@@ -283,7 +283,7 @@ commands:
283283
fi
284284
hide: true
285285

286-
# Override entrypoint to alter default behaviour of Ahoy.
286+
# Override entrypoint to alter default behavior of Ahoy.
287287
entrypoint:
288288
- bash
289289
- -c

.circleci/config.yml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ aliases:
4848
environment:
4949
# Set runner timezone to ensure that executed operations use correct timestamps.
5050
# https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
51-
TZ: "Australia/Melbourne"
51+
TZ: "UTC"
5252
# Set runner terminal capabilities.
5353
TERM: xterm-256color
5454
# Disable strict host key checking for SSH connections.
@@ -69,10 +69,8 @@ aliases:
6969
VORTEX_CI_TEST_RESULTS: &test_results /tmp/tests
7070
# Directory to store test artifacts.
7171
VORTEX_CI_ARTIFACTS: &artifacts /tmp/artifacts
72-
# Directory to store code exported between jobs.
73-
VORTEX_EXPORT_CODE_DIR: &vortex_build_export_dir /tmp/workspace/code
7472
# Directory to use for artifact deployments.
75-
VORTEX_DEPLOY_ARTIFACT_SRC: *vortex_build_export_dir
73+
VORTEX_DEPLOY_ARTIFACT_SRC: /tmp/workspace/code
7674
# Source code location for artifact deployments.
7775
VORTEX_DEPLOY_ARTIFACT_ROOT: *working_directory
7876
# Report file location for artifact deployments.
@@ -255,8 +253,9 @@ jobs:
255253
- run:
256254
name: Export built codebase
257255
command: |
258-
mkdir -p "${VORTEX_EXPORT_CODE_DIR}"
259-
docker compose cp -L cli:"/app/." "${VORTEX_EXPORT_CODE_DIR}"
256+
mkdir -p "/tmp/workspace/code"
257+
docker compose cp -L cli:"/app/." "/tmp/workspace/code"
258+
du -sh "/tmp/workspace/code"
260259
261260
- run:
262261
name: Install development dependencies

.env

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
##
22
# Project environment variables.
33
#
4-
# This is a single location where defined variables control how the stack
5-
# operates and should be the primary place for modifications. Avoid overriding
4+
# This is a single location where variables control how the project stack
5+
# operates. It should be the primary place for modifications. Avoid overriding
66
# values in scripts or configuration files to simplify future updates and
77
# centralize changes.
88
#
9-
# Values must be scalar and cannot reference another variable.
10-
# Do not enclose values in double quotes unless they include spaces.
9+
# A value must be scalar and cannot reference another variable.
10+
# Do not enclose a value in double quotes unless it includes spaces.
1111
#
1212
# To apply any changes made to this file, run `docker-compose up cli -d` or
1313
# `ahoy up cli`.
1414
#
15-
# To customize variables locally, copy `.env.local.example` to `.env.local`.
15+
# To customize variables locally, copy `.env.local.example` to `.env.local`,
16+
# and add your custom values there.
1617
#
1718
# @see https://vortex.drevops.com/workflows/variables
1819

@@ -30,14 +31,14 @@ VORTEX_PROJECT=your_site
3031
# Name of the web root directory containing a Drupal codebase.
3132
WEBROOT=web
3233

33-
# The timezone used in the containers.
34-
TZ="Australia/Melbourne"
34+
# The timezone used within the containers.
35+
TZ="UTC"
3536

3637
################################################################################
3738
# DRUPAL #
3839
################################################################################
3940

40-
# Drupal profile name (used only when installing from profile).
41+
# Drupal profile name.
4142
DRUPAL_PROFILE=standard
4243

4344
#;< DRUPAL_THEME
@@ -82,7 +83,7 @@ DRUPAL_CLAMAV_MODE=daemon
8283
# or fresh install from profile), running updates, appying configuration
8384
# changes, clearing caches and performing other tasks that prepare the site for
8485
# use.
85-
# @see https://vortex.drevops.com/workflows/provision
86+
# @see https://vortex.drevops.com/drupal/provision
8687

8788
# Set to 'profile' to install a site from profile instead of the database dump.
8889
VORTEX_PROVISION_TYPE=database
@@ -98,12 +99,13 @@ VORTEX_PROVISION_OVERRIDE_DB=0
9899
#
99100
# Database sanitization is enabled by default in all non-production
100101
# environments and is always skipped in the production environment.
102+
# @see https://vortex.drevops.com/drupal/provision#database-sanitization
101103
VORTEX_PROVISION_SANITIZE_DB_SKIP=0
102104

103105
# Sanitization email pattern.
104106
#
105107
# Applied if database sanitization is enabled.
106-
# @see https://vortex.drevops.com/workflows/build#sanitization
108+
# @see https://vortex.drevops.com/drupal/provision#database-sanitization
107109
VORTEX_PROVISION_SANITIZE_DB_EMAIL="user_%uid@your-site-domain.example"
108110

109111
# Put the site into a maintenance mode during site provisioning.
@@ -129,36 +131,40 @@ VORTEX_ACQUIA_APP_NAME=
129131
#;> HOSTING
130132

131133
################################################################################
132-
# DATABASE #
134+
# DATABASE SOURCE #
133135
################################################################################
134136

135137
# Database service runs a single database within a container.
136-
# See settings.php for database credentials defaults or run
137-
# `ahoy drush sql:connect`.
138+
# See settings.php for database credentials or run # `ahoy drush sql:connect`.
138139

139140
# Database can be imported from a *file dump* into an empty database started
140-
# from the database default image or can *exist* in a pre-built container image.
141+
# from the database default container image or can *exist* in a pre-built
142+
# container image.
141143
# Defaults to importing from a file.
142144
# @see https://vortex.drevops.com/workflows/database
143145

144146
# Database dump directory.
147+
#
148+
# The directory is used to store the database dump files for import and export.
145149
VORTEX_DB_DIR=./.data
146150

147151
# Database dump file name.
152+
#
153+
# The file is used to import the database into an empty database container.
148154
VORTEX_DB_FILE=db.sql
149155

150156
#;< !PROVISION_TYPE_PROFILE
151157
# Database download source.
152158
VORTEX_DB_DOWNLOAD_SOURCE=url
153159

154160
#;< DB_DOWNLOAD_SOURCE_CONTAINER_REGISTRY
155-
# Name of the pre-built container image.
161+
# Name of the pre-built database container image.
156162
# @see https://github.com/drevops/mariadb-drupal-data to seed your DB image.
157163
# VORTEX_DB_IMAGE=your_org/your_site:latest
158164
#;> DB_DOWNLOAD_SOURCE_CONTAINER_REGISTRY
159165

160166
#;< DB_DOWNLOAD_SOURCE_URL
161-
# Database dump file sourced from CURL.
167+
# Database dump file sourced from a URL.
162168
#
163169
# HTTP Basic Authentication credentials should be embedded into the value.
164170
VORTEX_DB_DOWNLOAD_URL=
@@ -211,14 +217,18 @@ VORTEX_DEPLOY_TYPES=artifact
211217

212218
# The channels of the notifications.
213219
#
214-
# Can be a combination of comma-separated values: email,newrelic,github,jira
220+
# A combination of comma-separated values: email,newrelic,github,jira
215221
VORTEX_NOTIFY_CHANNELS=email
216222

217-
# Email to send notifications from.
223+
# An email address to send notifications from.
224+
#
225+
# Applies to email notifications.
218226
VORTEX_NOTIFY_EMAIL_FROM="webmaster@your-site-domain.example"
219227

220228
# Email address(es) to send notifications to.
221229
#
230+
# Applies to email notifications.
231+
#
222232
# Multiple names can be specified as a comma-separated list of email addresses
223233
# with optional names in the format "email|name".
224234
# Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"

.github/workflows/build-test-deploy.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ jobs:
5959
image: drevops/ci-runner:25.5.0
6060

6161
env:
62-
TZ: Australia/Melbourne
62+
TZ: UTC
6363
TERM: xterm-256color
6464
VORTEX_SSH_DISABLE_STRICT_HOST_KEY_CHECKING: "1"
6565
VORTEX_SSH_REMOVE_ALL_KEYS: "1"
@@ -168,7 +168,7 @@ jobs:
168168
image: drevops/ci-runner:25.5.0
169169

170170
env:
171-
TZ: Australia/Melbourne
171+
TZ: UTC
172172
TERM: xterm-256color
173173
# Disable strict host key checking for SSH connections.
174174
VORTEX_SSH_DISABLE_STRICT_HOST_KEY_CHECKING: "1"
@@ -366,7 +366,7 @@ jobs:
366366
container:
367367
image: drevops/ci-runner:25.5.0
368368
env:
369-
TZ: Australia/Melbourne
369+
TZ: UTC
370370
TERM: xterm-256color
371371
VORTEX_SSH_DISABLE_STRICT_HOST_KEY_CHECKING: "1"
372372
VORTEX_DEBUG: ${{ vars.VORTEX_DEBUG }}

.vortex/docs/.utils/variables/extra/.env.local.example.variables.sh

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@
55
# shellcheck disable=SC2034
66

77
# Local development URL.
8+
#
9+
# Based on the `$COMPOSE_PROJECT_NAME` environment variable, which is set by
10+
# Docker Compose to the name of the project directory.
11+
#
812
# Override only if you need to use a different URL than the default.
9-
VORTEX_LOCALDEV_URL="<current_dir>.docker.amazee.io"
13+
VORTEX_LOCALDEV_URL="${COMPOSE_PROJECT_NAME:-example-site}.docker.amazee.io"
1014

1115
# Set to `1` to override existing downloaded DB dump without asking.
1216
VORTEX_DB_DOWNLOAD_FORCE=

.vortex/docs/.utils/variables/extra/.env.variables.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ VORTEX_DB_IMAGE_BASE=
1818
# Drupal admin email. May need to be reset if database was sanitized.
1919
DRUPAL_ADMIN_EMAIL="webmaster@your-site-domain.example"
2020

21-
# Password replacement used for sanitised database.
21+
# Password replacement used for sanitized database.
2222
VORTEX_PROVISION_SANITIZE_DB_PASSWORD="<RANDOM STRING>"
2323

2424
# Container registry name.

.vortex/docs/.utils/variables/extra/ci.variables.sh

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ VORTEX_DEPLOY_SKIP=
99
# Proceed with container image deployment after it was exported.
1010
VORTEX_EXPORT_DB_CONTAINER_REGISTRY_DEPLOY_PROCEED=
1111

12-
# Directory to store exported code.
13-
VORTEX_EXPORT_CODE_DIR=
14-
1512
# Ignore Hadolint failures.
1613
VORTEX_CI_HADOLINT_IGNORE_FAILURE=0
1714

@@ -69,3 +66,7 @@ RENOVATE_DRY_RUN=false
6966

7067
# Commit author for self-hosted Renovate bot.
7168
RENOVATE_GIT_AUTHOR='Renovate Self Hosted <renovatebot@your-site-domain.example>'
69+
70+
# Renovate repositories to manage.
71+
# Set as "organization/repository".
72+
RENOVATE_REPOSITORIES=

.vortex/docs/content/README.mdx

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,24 @@ sidebar_position: 1
1414
</h1>
1515
</div>
1616

17+
**Vortex** is a Drupal project template designed to streamline onboarding,
18+
accelerate development, and support long-term maintainability.
1719

18-
Welcome to <strong>Vortex</strong> &mdash; a project template for Drupal designed to simplify onboarding and website maintenance.
20+
It provides a complete foundation for building and deploying Drupal sites —
21+
including containerized local environments, automated testing and code quality
22+
tools, CI/CD pipeline configurations, and integrations with popular hosting
23+
platforms. Everything is pre-configured and ready to use, so teams can focus on
24+
building features instead of setting up infrastructure.
1925

20-
At [DrevOps&reg;](https://www.drevops.com/), we carefully maintain this
21-
template, keeping it aligned with the latest tools and validating it through
22-
automated tests to ensure everything works together seamlessly.
26+
By standardizing project structure and tooling, **Vortex** ensures a consistent
27+
developer experience across every project that uses it. Whether you’re starting
28+
fresh or joining an existing Vortex-based site, you can get up to speed quickly
29+
and start contributing right away.
2330

24-
Our goal is to provide a consistent developer experience across projects, making
25-
it easier to switch between them and get up to speed quickly.
31+
The template is actively maintained and kept in sync with the latest tools.
32+
Every change is verified through automated tests to ensure updates remain stable
33+
and reliable — reducing the risk of regressions and making it easier to maintain
34+
projects over time.
2635

2736
## Main features
2837

.vortex/docs/content/ci/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,5 @@ The CI pipeline is triggered by:
5858
Database is downloaded overnight and cached so that the next CI run on the same
5959
day uses the cached database dump.
6060

61-
By default, the database is cached per-branch for 24 hours. Of cache is not
61+
By default, the database is cached per-branch for 24 hours. If cache is not
6262
available, the fallback default branch is used.

.vortex/docs/content/contributing/maintenance/scripts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Follow these guidelines when creating or updating **Vortex** variables.
8282
1. Local variables MUST be in lowercase, and global variables MUST be in
8383
uppercase.
8484

85-
2. All **Vortex** variables MUST start with `VORTEX_` to separate Vortex from
85+
2. All **Vortex** variables MUST start with `VORTEX_` to separate **Vortex** from
8686
third-party variables.
8787

8888
3. Global variables MAY be re-used as-is across scripts. For instance, the

0 commit comments

Comments
 (0)