[#2133, #2029] Added sections about CI and hosting.

[AlexSkrypnyk]

Closes #2133, #2029

Summary by CodeRabbit

• Documentation
  • Expanded Continuous Integration docs with maintenance guidance (debug mode, runner image guidance, linter skip env vars, deploy-skip branch example).
  • Added full onboarding and maintenance guides for CircleCI and GitHub Actions (SSH key setup, secrets, schedules, timeouts, cache/versioning).
  • Added comprehensive Acquia and Lagoon hosting integration guides with onboarding and routine operation examples.
  • Added "Buildx" to the spellcheck dictionary.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds comprehensive onboarding and maintenance documentation for CI platforms (CircleCI, GitHub Actions) and hosting providers (Acquia, Lagoon), plus a CI README maintenance subsection and a cspell addition; all changes are documentation-only with no code or workflow logic modified.

Changes

Cohort / File(s)	Summary
Continuous Integration: overview & README .vortex/docs/content/continuous-integration/README.mdx	Added a Maintenance subsection detailing debug mode, CI runner image/versioning, linter skip environment variables, and deployment skip branch configuration.
Continuous Integration: CircleCI docs .vortex/docs/content/continuous-integration/circleci.mdx	Replaced placeholder with onboarding and maintenance guidance: SSH key onboarding, deployment configuration, environment variable examples, cache/versioning, runner resources, parallelism, and debug/timeouts.
Continuous Integration: GitHub Actions docs .vortex/docs/content/continuous-integration/github-actions.mdx	Replaced placeholder with onboarding and maintenance guidance: workflow enablement, SSH key setup, secrets configuration, YAML examples (branches, cron, cache, runner size, matrix parallelism, tmate, timeouts).
Hosting: Acquia integration .vortex/docs/content/hosting/acquia.mdx	Replaced placeholder with a full Acquia integration guide covering overview, integration points, onboarding prerequisites, env vars, Drush alias guidance, and routine operations examples.
Hosting: Lagoon integration .vortex/docs/content/hosting/lagoon.mdx	Replaced placeholder with a full Lagoon integration guide covering tasks, deployment automation, environment detection, onboarding, env var/CI secret configuration, and routine operations.
Spellcheck dictionary .vortex/docs/cspell.json	Added the word Buildx to the cspell custom words list.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Documentation-only changes; consistent patterns across files.
• Attention points:
  • Verify SSH/key commands and secret names in CI docs for accuracy.
  • Confirm YAML snippets match repository CI conventions.
  • Check Acquia/Lagoon onboarding env var names and example commands.

Possibly related issues

• [DOCS] Add sections about hosting and CI #2133 — Directly aligns with adding CI and hosting onboarding/maintenance documentation.

Possibly related PRs

• Added more docs. #1849 — Modifies the Continuous Integration README; likely overlaps with README edits here.
• [#1626] Added e2e deploy diagram, updated documentation structure and fixed typos. #2130 — Overlapping documentation edits across CI and hosting MDX files.
• Added Vortex release version to docs. #2131 — Related site/docs config and Vortex release workflow references that may interact with these docs.

Suggested labels

AUTOMERGE

Poem

🐰 New pages sprout where placeholders lay,
Keys and secrets taught the proper way,
CircleCI and Actions hum along,
Acquia, Lagoon join the docu-song,
Hop, nibble, read — the rabbit says hooray! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes, which add comprehensive CI and hosting documentation sections across multiple files.
Linked Issues check	✅ Passed	The pull request adds documentation sections for CI (CircleCI, GitHub Actions, README) and hosting (Acquia, Lagoon) as required by issue #2133.
Out of Scope Changes check	✅ Passed	All changes are scoped to documentation additions with one minor spell-check dictionary update (cspell.json), all aligned with the CI and hosting documentation objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/2133-docs-add-sections-about-ci-hosting

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6385977 and de70281.

📒 Files selected for processing (6)

• .vortex/docs/content/continuous-integration/README.mdx (1 hunks)
• .vortex/docs/content/continuous-integration/circleci.mdx (1 hunks)
• .vortex/docs/content/continuous-integration/github-actions.mdx (1 hunks)
• .vortex/docs/content/hosting/acquia.mdx (1 hunks)
• .vortex/docs/content/hosting/lagoon.mdx (1 hunks)
• .vortex/docs/cspell.json (1 hunks)

🧰 Additional context used

🪛 LanguageTool

.vortex/docs/content/continuous-integration/github-actions.mdx

[uncategorized] ~32-~32: The official name of this software platform is spelled with a capital “H”.
Context: ...d. Vortex provides the workflow file at [.github/workflows/build-test-deploy.yml](https...

(GITHUB)

---

[uncategorized] ~106-~106: The official name of this software platform is spelled with a capital “H”.
Context: ... on.pull_request.branches sections of .github/workflows/build-test-deploy.yml: ```y...

(GITHUB)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

• GitHub Check: build (1)
• GitHub Check: build (0)
• GitHub Check: vortex-test-workflow (4)
• GitHub Check: vortex-test-common
• GitHub Check: vortex-test-workflow (1)
• GitHub Check: vortex-test-workflow (3)
• GitHub Check: vortex-test-workflow (0)
• GitHub Check: vortex-test-workflow (2)
• GitHub Check: vortex-test-installer (8.3)
• GitHub Check: vortex-test-installer (8.4)
• GitHub Check: vortex-test-docs

🔇 Additional comments (14)

.vortex/docs/cspell.json (1)

11-11: Correct placement and necessary for CI documentation.

"Buildx" is properly positioned alphabetically in the words list and supports the CI runner documentation that references Docker Buildx as a pre-installed tool.

.vortex/docs/content/continuous-integration/circleci.mdx (2)

20-109: Well-structured onboarding section with clear, actionable steps.

The onboarding flow is comprehensive and properly sequenced: project enablement → SSH key setup (database) → SSH key setup (deployment) → fingerprint configuration → environment variables. The naming convention tip (lines 46-53) and the note about separate providers (lines 65-71) are helpful contextual guidance.

---

110-184: Comprehensive and well-organized maintenance documentation.

The maintenance section covers all key operational adjustments with clear examples: deployment branches, nightly schedules, cache resets, runner resources, test parallelism, SSH debugging, and build timeouts. Each subsection includes YAML snippets or command references for easy copy-paste implementation.

.vortex/docs/content/hosting/acquia.mdx (2)

7-12: Clear introduction with proper external documentation links.

The overview concisely explains Acquia's purpose and provides a link to official docs for deeper reference. This follows good documentation practices.

---

67-68: Cross-references to CI platforms are correctly formatted.

Links to GitHub Actions and CircleCI documentation sections use the correct doc path syntax (/docs/continuous-integration/...) and will enable readers to navigate between hosting and CI documentation seamlessly.

Please verify that the target paths /docs/continuous-integration/github-actions and /docs/continuous-integration/circleci exist in the deployed documentation structure.

.vortex/docs/content/hosting/lagoon.mdx (2)

7-12: Clear introduction with proper external documentation links.

The overview clearly describes Lagoon's purpose and provides a link to official docs for additional reference. Consistent with the Acquia section's approach.

---

62-72: Helpful default values for Lagoon SSH configuration.

Providing default SSH host and port values (lines 65-66) helps users who may not be familiar with Lagoon's standard infrastructure. The optional designation for these variables is appropriate since defaults cover common use cases.

.vortex/docs/content/continuous-integration/README.mdx (2)

112-115: Accurate and comprehensive tooling summary for drevops/ci-runner.

The list of pre-installed tools (PHP, Node.js, Docker, code quality tools, utilities) accurately reflects what developers need for CI execution. This helps justify why using the standardized image is important for consistency.

---

124-137: Clear guidance on conditional linter failures.

The maintenance table provides a straightforward reference for developers needing to temporarily skip linters during development. The *_IGNORE_FAILURE pattern is consistent and easy to remember.

.vortex/docs/content/continuous-integration/github-actions.mdx (5)

21-82: Well-structured onboarding with clear SSH key setup and secrets configuration.

The onboarding section properly sequences workflow enablement, SSH key generation (with concrete bash commands), and secrets configuration. The mirroring of CircleCI's approach ensures consistency across CI platforms while appropriately adapting to GitHub Actions' secret management (repository secrets instead of project settings).

---

103-116: GitHub Actions deployment branch configuration is clear and practical.

The branch patterns in on.push.branches and on.pull_request.branches use standard YAML glob syntax (lines 112-115: feature/**), which is simpler and more appropriate than regex for GitHub Actions. This is a meaningful difference from CircleCI's regex approach, and it's correctly documented here.

---

129-139: Cache reset guidance with concrete version example is helpful.

Showing the version bump from v25.10.0 to v25.10.1 (lines 136-138) provides a concrete example that makes the mechanism clear. This is more actionable than abstract guidance.

---

150-160: Matrix strategy example for test parallelism is well-presented.

The example using instance: [0, 1, 2, 3] (lines 159) is concrete and easy to adapt. The link to GitHub's official documentation on matrix jobs is also helpful for users who want to learn more.

---

162-167: Terminal access via tmate is a valuable debugging feature.

Referencing the tmate action and providing the proper workflow trigger option ("Enable terminal session") helps developers quickly access SSH debugging without needing to search for the mechanism.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92a94c2 and 6385977.

📒 Files selected for processing (5)

• .vortex/docs/content/continuous-integration/README.mdx (1 hunks)
• .vortex/docs/content/continuous-integration/circleci.mdx (1 hunks)
• .vortex/docs/content/continuous-integration/github-actions.mdx (1 hunks)
• .vortex/docs/content/hosting/acquia.mdx (1 hunks)
• .vortex/docs/content/hosting/lagoon.mdx (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Vortex - Test docs

.vortex/docs/content/continuous-integration/README.mdx

[error] 113-113: CSpell: Unknown word (Buildx).

🪛 LanguageTool

.vortex/docs/content/continuous-integration/github-actions.mdx

[uncategorized] ~31-~31: The official name of this software platform is spelled with a capital “H”.
Context: ...d. Vortex provides the workflow file at [.github/workflows/build-test-deploy.yml](https...

(GITHUB)

---

[uncategorized] ~105-~105: The official name of this software platform is spelled with a capital “H”.
Context: ... on.pull_request.branches sections of .github/workflows/build-test-deploy.yml: ```y...

(GITHUB)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)

• GitHub Check: build (1)
• GitHub Check: build (0)
• GitHub Check: vortex-test-workflow (3)
• GitHub Check: vortex-test-workflow (4)
• GitHub Check: vortex-test-workflow (1)
• GitHub Check: vortex-test-workflow (2)
• GitHub Check: vortex-test-workflow (0)
• GitHub Check: vortex-test-common
• GitHub Check: vortex-test-installer (8.3)
• GitHub Check: vortex-test-installer (8.4)

🔇 Additional comments (10)

.vortex/docs/content/hosting/lagoon.mdx (2)

7-46: Comprehensive Lagoon integration documentation looks good.

The documentation effectively covers integration tasks, deployment automation, and environment detection with clear references to relevant configuration files. Content is well-structured and consistent with the Acquia hosting documentation.

---

56-72: Environment variable configuration is clear and well-documented.

The distinction between local environment variables (.env file) and CI secrets is properly communicated with cross-references to CI provider documentation.

.vortex/docs/content/hosting/acquia.mdx (2)

7-48: Acquia integration documentation is comprehensive and well-structured.

The documentation clearly explains integration tasks (database operations, cache purging), deployment automation via Cloud Hooks, and automatic environment detection. The integration with Acquia-specific tools is well-explained.

---

73-78: Drush alias configuration guidance is helpful.

The optional Drush alias setup section provides clear guidance with a link to official Acquia documentation for users who want to run Drush commands remotely.

.vortex/docs/content/continuous-integration/circleci.mdx (1)

20-52: SSH key onboarding is well-explained with security best practices.

The documentation clearly guides users through SSH key generation with proper PEM format (lines 42) and includes a helpful naming convention tip for managing multiple keys. The distinction between database download and deployment keys is clearly explained.

.vortex/docs/content/continuous-integration/README.mdx (2)

99-145: Maintenance section provides valuable operational guidance.

The new Maintenance section covers debug mode, CI runner image updates, linter control, and deployment conditions. The comprehensive linter table and clear examples make this section practical and useful for developers.

---

106-122: CSpell is not configured in this project; the false positive flagging cannot be verified.

No CSpell configuration files (.cspell.json, cspell.config.*, .cspellrc*) exist in the repository, and no CSpell references were found in package.json or elsewhere in the codebase. Since CSpell does not appear to be active in this project, the claim that "Buildx" is flagged as an unknown word cannot be substantiated. If spell checking is not configured, there is no action required.

Likely an incorrect or invalid review comment.

.vortex/docs/content/continuous-integration/github-actions.mdx (3)

7-19: GitHub Actions introduction and setup guidance is clear.

The onboarding section properly directs users to the workflow file location and explains that no additional setup is required beyond secret configuration. The info block correctly references the CI overview documentation.

---

21-82: SSH key and secret configuration is well-explained with helpful conventions.

The documentation provides consistent guidance with the CircleCI documentation, including the same key naming convention tip. The distinction between database and deployment keys is clearly explained, with the note about different source and destination providers.

---

100-177: Maintenance section provides practical examples for common CI adjustments.

The Maintenance section covers deployment branches, nightly database scheduling, cache version management, runner sizing, test parallelism, and tmate debugging. The examples are clear and actionable. However, verify that the cache key format is consistent with the CI overview documentation.

The cache key format uses v25.10.0-db11 pattern (line 135). Please verify this is consistent with the versioning scheme described in the README.mdx Maintenance section (line 121: "Year-Month-Patch versioning (e.g., 25.10.0)").

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.89%. Comparing base (92a94c2) to head (de70281).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2143   +/-   ##
========================================
  Coverage    70.89%   70.89%           
========================================
  Files           99       99           
  Lines         5075     5075           
  Branches        44       44           
========================================
  Hits          3598     3598           
  Misses        1477     1477           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.