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

Renamed more references to Vortex. #1391

Merged
merged 1 commit into from
Aug 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .ahoy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ commands:
cmd: ./scripts/vortex/doctor.sh "$@"

update-vortex:
usage: Update DrevOps stack.
usage: Update Vortex stack.
cmd: |
ahoy confirm "Some committed files may become overwritten. Proceed?" &&
./scripts/vortex/update-vortex.sh $@
Expand Down
6 changes: 3 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ aliases:
# Directory to store test artifacts.
VORTEX_CI_ARTIFACTS: &artifacts /tmp/artifacts
# Directory to store code exported between jobs.
VORTEX_EXPORT_CODE_DIR: &drevops_build_export_dir /tmp/workspace/code
VORTEX_EXPORT_CODE_DIR: &vortex_build_export_dir /tmp/workspace/code
# Directory to use for artifact deployments.
VORTEX_DEPLOY_ARTIFACT_SRC: *drevops_build_export_dir
VORTEX_DEPLOY_ARTIFACT_SRC: *vortex_build_export_dir
# Source code location for artifact deployments.
VORTEX_DEPLOY_ARTIFACT_ROOT: *working_directory
# Report file location for artifact deployments.
Expand Down Expand Up @@ -461,7 +461,7 @@ jobs:
# 2. DB is image -> create data image -> cache data image and push it to registry -> build and test site
#
# Since we need to have "database" job generic for consumer sites and any
# logic is controlled within DrevOps scripts, we have to create additional
# logic is controlled within Vortex scripts, we have to create additional
# test jobs below and run them as a part of the CI system for Vortex itself.
#
# Job to test creation of the image from DB dump file when using
Expand Down
16 changes: 8 additions & 8 deletions .env
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#
# To customize variables locally, copy `.env.local.default` to `.env.local`.
#
# @see https://docs.drevops.com/workflows/variables
# @see https://vortex.drevops.com/workflows/variables

################################################################################
# GENERAL #
Expand Down Expand Up @@ -72,7 +72,7 @@ DRUPAL_CLAMAV_MODE=daemon
################################################################################

# Variables in this section control how the site is provisioned.
# @see https://docs.drevops.com/workflows/provision
# @see https://vortex.drevops.com/workflows/provision

# Set to 1 to install a site from profile instead of the database file dump.
VORTEX_PROVISION_USE_PROFILE=0
Expand All @@ -92,7 +92,7 @@ VORTEX_PROVISION_SANITIZE_DB_SKIP=0

# Sanitization email pattern. Sanitization is enabled by default in all
# non-production environments.
# @see https://docs.drevops.com/workflows/build#sanitization
# @see https://vortex.drevops.com/workflows/build#sanitization
VORTEX_PROVISION_SANITIZE_DB_EMAIL="user_%[email protected]"

# Put the site into a maintenance mode during site provisioning.
Expand All @@ -108,7 +108,7 @@ VORTEX_PROVISION_USE_MAINTENANCE_MODE=1
# Database can be imported from a file dump into an empty database started from
# the database default image or can exist in a pre-built container image.
# Defaults to importing from a file.
# @see https://docs.drevops.com/workflows/database
# @see https://vortex.drevops.com/workflows/database

# Database dump directory.
VORTEX_DB_DIR=./.data
Expand Down Expand Up @@ -177,14 +177,14 @@ LAGOON_PROJECT=your_site
################################################################################

# Deployment occurs when tests pass in the CI environment.
# @see https://docs.drevops.com/workflows/deployment
# @see https://vortex.drevops.com/workflows/deployment

# The type of deployment.
#
# Combination of comma-separated values to support multiple deployment targets:
# `artifact`,`container_registry`, `webhook`, `lagoon`.
#
# See https://docs.drevops.com/workflows/deploy
# See https://vortex.drevops.com/workflows/deploy
VORTEX_DEPLOY_TYPES=artifact

#;< LAGOON
Expand All @@ -200,7 +200,7 @@ VORTEX_LAGOON_PRODUCTION_BRANCH=main
################################################################################

# Notificaions are sent accross multiple channels before and after deployment.
# @see https://docs.drevops.com/workflows/notifications
# @see https://vortex.drevops.com/workflows/notifications

# The channels of the notifications.
#
Expand Down Expand Up @@ -236,7 +236,7 @@ VORTEX_NOTIFY_EMAIL_RECIPIENTS="[email protected]"
#;< VORTEX_DB_DOWNLOAD_SOURCE_CURL
# URL of the demo database used for demonstration with CURL database
# dump as a type of file source.
VORTEX_DB_DOWNLOAD_CURL_URL=https://github.com/drevops/scaffold/releases/download/1.18.0/db_d10.demo.sql
VORTEX_DB_DOWNLOAD_CURL_URL=https://github.com/drevops/vortex/releases/download/1.18.0/db_d10.demo.sql
#;> VORTEX_DB_DOWNLOAD_SOURCE_CURL

#;< VORTEX_DB_IMAGE
Expand Down
2 changes: 1 addition & 1 deletion .env.local.default
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#
# The .env.local file is excluded via .gitignore and will not be committed.
#
# @see https://docs.drevops.com/workflows/variables
# @see https://vortex.drevops.com/workflows/variables

# Suppress Ahoy prompts.
# AHOY_CONFIRM_RESPONSE=y
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/vortex-release-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:
run: |
cd "${GITHUB_WORKSPACE}/.vortex/docs"
export DOCS_PUBLISH_SRC_DIR="${GITHUB_WORKSPACE}/.vortex/docs/build"
export [email protected]:drevops/docs.git
export DOCS_PUBLISH_COMMIT_MESSAGE="Automatically pushed from drevops/scaffold"
export DOCS_PUBLISH_GIT_EMAIL="[email protected]"
export [email protected]:drevops/vortex-docs.git
export DOCS_PUBLISH_COMMIT_MESSAGE="Automatically pushed from drevops/vortex"
export DOCS_PUBLISH_GIT_EMAIL="deployer+vortex@drevops.com"
./.utils/publish.sh
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ web/sites/default/*
# Preserve default settings files to use them in Functional test.
!web/sites/default/default.settings.php
!web/sites/default/default.services.yml
# Whitelist scaffold files. @see https://github.com/drupal-composer/drupal-scaffold#limitation
# Whitelist Drupal Scaffold files. @see https://github.com/drupal-composer/drupal-scaffold#limitation
!web/.editorconfig
!web/.eslintignore
!web/.gitattributes
Expand Down
2 changes: 1 addition & 1 deletion .gitignore.artifact
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
web/sites/default/files
web/sites/simpletest

# Ignore non-production scaffold files.
# Ignore non-production Drupal Scaffold files.
web/sites/default/default.services.local.yml
web/sites/default/default.settings.local.php

Expand Down
2 changes: 1 addition & 1 deletion .lagoon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ environment_variables:
tasks:
post-rollout:
- run:
name: Show DrevOps variables.
name: Show Vortex variables.
command: |
[ "${VORTEX_DEBUG-}" = "1" ] && env -0 | sort -z | tr '\0' '\n' | grep ^VORTEX_ || true
service: cli
Expand Down
2 changes: 1 addition & 1 deletion .vortex/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Vortex development

This directory contains development files for the scaffold itself.
This directory contains development files for Vortex itself.
This directory is removed by the installer or can be deleted manually.
2 changes: 1 addition & 1 deletion .vortex/docs/content/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ Refer to [Contributing](contributing) for more details.
## License

Vortex is licensed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) license. See
the [LICENSE](https://github.com/drevops/scaffold/blob/develop/LICENSE) file for more details.
the [LICENSE](https://github.com/drevops/vortex/blob/develop/LICENSE) file for more details.
4 changes: 2 additions & 2 deletions .vortex/docs/content/contributing/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ glad for your willingness to assist!

We're constantly eager to address any issues, so your reports are always
appreciated. However, we kindly ask you to first check if your problem has
already been reported in the [issue queue](https://github.com/drevops/scaffold/issues).
already been reported in the [issue queue](https://github.com/drevops/vortex/issues).

## I want to suggest a feature or an idea

Fantastic! Please [submit your idea](https://github.com/drevops/scaffold/issues)
Fantastic! Please [submit your idea](https://github.com/drevops/vortex/issues)
and we'll gladly review it. While we can't promise every suggestion will be
implemented, we are always keen to hear innovative ideas for enhancing
the **Vortex**.
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/contributing/code-of-conduct.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Code of conduct

Please note that this project is released with
a [Contributor Code of Conduct](https://github.com/drevops/scaffold/blob/develop/CODE_OF_CONDUCT.md). By participating in this
a [Contributor Code of Conduct](https://github.com/drevops/vortex/blob/develop/CODE_OF_CONDUCT.md). By participating in this
project you agree to abide by its terms.
12 changes: 6 additions & 6 deletions .vortex/docs/content/contributing/maintenance/documentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
There are 2 types of the documentation that **Vortex** provides:

1. This Documentation of **Vortex** that is then deployed
to https://docs.drevops.com/
to https://vortex.drevops.com/
2. Consumer site documentation that is distributed when **Vortex** is
installed.

## docs.drevops.com
## vortex.drevops.com

The Documentation (this site) is written in Markdown and located in
[`.vortex/docs`](https://github.com/drevops/scaffold/blob/develop/.vortex/docs) directory. This is
[`.vortex/docs`](https://github.com/drevops/vortex/blob/develop/.vortex/docs) directory. This is
removed when you install **Vortex** for a
consumer site.

Expand Down Expand Up @@ -46,15 +46,15 @@ file.

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 tag, publishes to https://vortex.drevops.com/
- on every commit to a branch that contains `release-docs` string publishes to https://vortex.drevops.com/
- 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

**Vortex** provides a scaffold of the consumer site documentation in the
[`docs`](https://github.com/drevops/scaffold/blob/develop/docs) directory.
[`docs`](https://github.com/drevops/vortex/blob/develop/docs) directory.

After **Vortex** is installed into the consumer site, these docs are
intended to be used by the site maintainers and stay up-to-date with the
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/contributing/maintenance/release.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Follow the steps below to release a new version of the Vortex:

1. Run renovate bot locally to update all dependencies outside of the schedule:
```
renovate --schedule= --force-cli=true drevops/scaffold
renovate --schedule= --force-cli=true drevops/vortex
```
2. Update container images to the latest versions and check that `@see` links are working.
3. Update PHP version in `composer.json` for `config.platform`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
set -eu
[ "${VORTEX_DEBUG-}" = "1" ] && set -x

# Example scaffold variable with a default value.
# Example Vortex variable with a default value.
VORTEX_EXAMPLE_URL="${VORTEX_EXAMPLE_URL:-http://example.com}"

# ------------------------------------------------------------------------------
Expand All @@ -21,12 +21,12 @@ pass() { [ "${TERM:-}" != "dumb" ] && tput colors >/dev/null 2>&1 && printf "\03
fail() { [ "${TERM:-}" != "dumb" ] && tput colors >/dev/null 2>&1 && printf "\033[31m[FAIL] %s\033[0m\n" "${1}" || printf "[FAIL] %s\n" "${1}"; }
# @formatter:on

info "Started scaffold operations."
info "Started Vortex operations."

[ -z "${VORTEX_EXAMPLE_URL}" ] && fail "Missing required value for VORTEX_EXAMPLE_URL" && exit 1
command -v curl >/dev/null || (fail "curl command is not available." && exit 1)

# Example of the script body.
curl -L -s -o /dev/null -w "%{http_code}" "${VORTEX_EXAMPLE_URL}" | grep -q '200\|403' && note "Requested example page"

pass "Finished scaffold operations."
pass "Finished Vortex operations."
2 changes: 1 addition & 1 deletion .vortex/docs/content/contributing/maintenance/tests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ AHOY_CONFIRM_RESPONSE=1 ahoy build
ahoy export-db
```
4. Make sure that exported DB does not have data in `cache_*` and `watchdog` tables.
5. Upload DB to https://github.com/drevops/scaffold/wiki as a test file (`db.distN.sql`).
5. Upload DB to https://github.com/drevops/vortex/wiki as a test file (`db.distN.sql`).
6. Update references in code from `db.demo.sql` to `db.distN.sql`.
7. Run CI build.
8. Revert updated references to `db.demo.sql`.
Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/drupal/module-scaffold.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 4

# Module scaffold

[Module scaffold](https://github.com/drevops/scaffold/tree/develop/web/modules/custom/ys_core)
[Module scaffold](https://github.com/drevops/vortex/tree/develop/web/modules/custom/ys_core)
is an example of a Drupal module.

We recommend creating a custom `ys_core` module for your project to place
Expand Down
12 changes: 6 additions & 6 deletions .vortex/docs/content/drupal/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ The `settings.php` file provides the primary configuration for a Drupal site,
including its database connection, file paths, and various other settings.

**Vortex** ships with own streamlined version of
the [`settings.php`](https://github.com/drevops/scaffold/blob/develop/web/sites/default/settings.php) and
[`services.yml`](https://github.com/drevops/scaffold/blob/develop/web/sites/default/services.yml) files.
the [`settings.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/settings.php) and
[`services.yml`](https://github.com/drevops/vortex/blob/develop/web/sites/default/services.yml) files.

It also provides [Settings unit tests](#testing-settings-with-unit-tests) to ensure that
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)
and [`default.services.yml`](https://github.com/drevops/scaffold/blob/develop/web/sites/default/default.services.yml)
The default **Drupal Scaffold**'s [`default.settings.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/default.settings.php)
and [`default.services.yml`](https://github.com/drevops/vortex/blob/develop/web/sites/default/default.services.yml)
files are also provided if you choose to use them instead.

The [`settings.php`](https://github.com/drevops/scaffold/blob/develop/web/sites/default/settings.php) file is divided
The [`settings.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/settings.php) file is divided
into several sections:

import CodeBlock from '@theme/CodeBlock';
Expand Down Expand Up @@ -148,7 +148,7 @@ functionality.

## Testing settings with unit tests

**Vortex** provides a [set of unit tests](https://github.com/drevops/scaffold/blob/develop/tests/phpunit/Drupal) that
**Vortex** provides a [set of unit tests](https://github.com/drevops/vortex/blob/develop/tests/phpunit/Drupal) that
ensure that 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.
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 @@ -104,7 +104,7 @@ compile sources, or waiting for someone upstream to update the code.

:::note

We are [looking into providing](https://github.com/drevops/scaffold/issues/1198) `pre-` and `post-` hooks for scripts so
We are [looking into providing](https://github.com/drevops/vortex/issues/1198) `pre-` and `post-` hooks for scripts so
that you can extend the functionality without modifying the original source
code.

Expand Down
6 changes: 3 additions & 3 deletions .vortex/docs/content/getting-started/faqs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Yes, you can change anything you want. **Vortex** is a project template,
which means that you can disable/remove certain features. But it also means that
you may need to maintain these changes in the future yourself.

Feel free to [open an issue](https://github.com/drevops/scaffold/issues) to
Feel free to [open an issue](https://github.com/drevops/vortex/issues) to
discuss any of the decisions made in **Vortex**.

## I do not need all these features? It looks like an overkill.
Expand Down Expand Up @@ -81,7 +81,7 @@ are also some that have to stay in order to make tools "talk" to each other.

There could be some cases when it is unreasonably opinionated - we consider this
as a defect and would be happy to fix it. Please provide your feedback in the
[issue queue](https://github.com/drevops/scaffold/issues).
[issue queue](https://github.com/drevops/vortex/issues).

## How easy is it to upgrade **Vortex** in my project?

Expand Down Expand Up @@ -126,7 +126,7 @@ same way as it would be built in your hosting (if your hosting uses Docker).
The other reason is that CircleCI supports passing the build artifacts between
jobs via cache. This becomes really powerful on large consumer sites, where
building the project takes a long time. **Vortex** mitigates this by
providing a [CI configuration](https://github.com/drevops/scaffold/blob/develop/.circleci/config.yml)
providing a [CI configuration](https://github.com/drevops/vortex/blob/develop/.circleci/config.yml)
used to download and cache the database overnight and use this cache for all
the builds during the day, skipping the long database download and import
process.
Expand Down
16 changes: 8 additions & 8 deletions .vortex/docs/content/getting-started/features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ The following list includes ✅ completed and 🚧 upcoming features.
* ✅ Based on [drupal-composer/drupal-project](https://github.com/drupal-composer/drupal-project)
*[Drupal 10](https://www.drupal.org/project/drupal)
* ✅ Configurable webroot
*[Pre-configured settings](https://github.com/drevops/scaffold/blob/develop/web/sites/default/settings.php)
*[Custom module scaffold](https://github.com/drevops/scaffold/blob/develop/web/modules/custom/ys_core)
*[Custom theme scaffold](https://github.com/drevops/scaffold/blob/develop/web/themes/custom/your_site_theme)
*[Tests scaffold](https://github.com/drevops/scaffold/blob/develop/web/modules/custom/ys_core/tests)
*[Pre-configured settings](https://github.com/drevops/vortex/blob/develop/web/sites/default/settings.php)
*[Custom module scaffold](https://github.com/drevops/vortex/blob/develop/web/modules/custom/ys_core)
*[Custom theme scaffold](https://github.com/drevops/vortex/blob/develop/web/themes/custom/your_site_theme)
*[Tests scaffold](https://github.com/drevops/vortex/blob/develop/web/modules/custom/ys_core/tests)
* ✅ Configuration for admin modules: [Environment indicator](https://www.drupal.org/project/environment_indicator), [Shield](https://www.drupal.org/project/shield), [Stage file proxy](https://www.drupal.org/project/stage_file_proxy)
* ✅ Configuration for [Search API](https://www.drupal.org/project/search_api) ([Solr](https://www.drupal.org/project/search_api_solr))
* ✅ Configuration for caching ([Redis](https://www.drupal.org/project/redis))
Expand Down Expand Up @@ -56,7 +56,7 @@ The following list includes ✅ completed and 🚧 upcoming features.
* 🚧 [Pa11y](https://pa11y.org/)
* ⚙️ Workflow
* ✅ Database from FTP, CURL, container image, hosting provider
*[Pull request template](https://github.com/drevops/scaffold/blob/develop/.github/PULL_REQUEST_TEMPLATE.md)
*[Pull request template](https://github.com/drevops/vortex/blob/develop/.github/PULL_REQUEST_TEMPLATE.md)
*[Release drafter](https://github.com/release-drafter/release-drafter)
*[PR auto-assign](https://github.com/toshimaru/auto-author-assign)
*[PR auto-label](https://github.com/eps1lon/actions-label-merge-conflict)
Expand All @@ -66,9 +66,9 @@ The following list includes ✅ completed and 🚧 upcoming features.
* ✅ Deployment notification to New Relic
* ✅ Automated dependencies updates ([Renovate](https://www.mend.io/renovate/))
* 📖 Documentation
* ✅ Your project [README.md](https://github.com/drevops/scaffold/blob/develop/README.dist.md)
* ✅ Your [project documentation](https://github.com/drevops/scaffold/blob/develop/docs)
*[Vortex documentation](https://docs.drevops.com/)
* ✅ Your project [README.md](https://github.com/drevops/vortex/blob/develop/README.dist.md)
* ✅ Your [project documentation](https://github.com/drevops/vortex/blob/develop/docs)
*[Vortex documentation](https://vortex.drevops.com/)
* 🧪 Vortex
* ✅ Unit test coverage for scripts
* ✅ Functional test coverage for workflows
Expand Down
Loading