Skip to content

docs: add maintainer handover and Lambda deployment runbooks - #219

Merged
marissahuysentruyt merged 1 commit into
mainfrom
cpeyer-adobe-preview-lambda-deployment
Nov 10, 2026
Merged

marissahuysentruyt merged 1 commit into
mainfrom
cpeyer-adobe-preview-lambda-deployment

Conversation

@chrischrischris

@chrischrischris chrischrischris commented Nov 10, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Add a maintainer handover and separate preview/production Lambda deployment runbooks so successors and their AI assistants can find the correct procedures without reconstructing the system.

  • Map architecture, ownership, access prerequisites, scheduled jobs, troubleshooting, and credential-management responsibilities.
  • Document explicit AWS targets/profile, environment-preservation safeguards, login, approval checkpoints, cache invalidation, verification, and rollback considerations.
  • Include copyable AI-assistant prompts and link the guides from the project and Lambda READMEs.

Documentation only: no application or infrastructure changes. No actual credential values were found in the changed files. The internal login URL was replaced with an approved-portal placeholder before committing; resource IDs and secret names are already documented in this repository. Live service configuration and ownership still require operator confirmation.

Screenshots (if applicable)

N/A: Markdown-only changes.

Type of change

  • Bug fix
  • New feature / block
  • Refactor
  • Docs / content
  • Chore (deps, config, tooling)

Related issue(s)

  • No linked ticket, as confirmed by the requester.

Validation steps

  • This PR has visual elements, so it was reviewed by a designer.
  • This PR has code changes, and our linters still pass.
  • This PR affects production code, so it was browser tested (see below).
  • This PR affects existing pages, so automated E2E tests were run (see below).
  • This PR has new code, so new tests were added or updated, and they pass.
  • This PR has copy changes, so copy was proofread and approved.
  • The content of this PR requires documentation, so a detailed description of the component's purpose, requirements, quirks, and instructions for use by designers and developers was added, along with accessibility information if pertinent.

Completed checks:

  • git diff --check: passed.
  • git diff --cached --check: passed before committing.
  • Local documentation checks: relative-link targets exist, Bash examples parse after replacing the documented invalidation-ID placeholder, and the internal login hostname and common credential patterns are absent from the changed files. Pattern checks are not a guarantee of organizational publication approval.

Runtime tests, lint, browser checks, and accessibility tests were not run because this change only adds Markdown and links. Deployment, login, invalidation, and rotation commands were not executed; no AWS resources were changed.

To Validate

URL for testing:
N/A: documentation-only changes. Review docs/HANDOVER.md, workers/website-lambda/DEPLOY-PREVIEW.md, and workers/website-lambda/DEPLOY-PROD.md in this branch.

  • Make sure all PR Checks have passed
  • Pull down the branch locally or visit the branch preview
  • Run npm test and confirm all tests pass
  • Run npm run lint and confirm no linting errors
  • Verified in browser with aem up
  • Follow the new links from the project README and Lambda README; confirm the intended guides open.
  • Confirm preview commands select stage, spectrum-stage-lambda-proxy, and its distribution; production commands select prod, spectrum-prod-lambda-proxy, and its distribution. Both explicitly use profile default and region us-east-2.
  • Confirm environment-preservation guards, operator-owned sign-in, approval checkpoints, and cache/verification requirements agree with current operations. Do not execute service-changing commands solely to review this PR.
  • Confirm the credential checklist contains names and ownership requirements, not credential values; operational facts not verified live remain identified as such.

Acceptance criteria: a successor can find authoritative subsystem guides, understand separate content/code/Lambda release paths, prepare the correct deployment without overwriting environment configuration, and identify access/ownership information that must be obtained internally.

Accessibility testing checklist

  • Keyboard
  1. Open the rendered handover and deployment Markdown on GitHub.
  2. Tab through guide links and activate a documentation link with Enter.
  3. Expect the intended document to open. No application controls or focus behavior changed; this check is not yet performed.
  • Screen reader
  1. Open the rendered guides with a screen reader.
  2. Navigate headings, tables, and links.
  3. Expect meaningful headings, table headers, and link names. No application ARIA or semantic output changed; this check is not yet performed.

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

N/A: no application UI changes; rendered-document device review has not been performed.

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

- document preview and production operations with explicit safeguards
- map service ownership and credential handover without secret values
- keep internal login URLs out of public documentation

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@aem-code-sync

aem-code-sync Bot commented Nov 10, 2026

Copy link
Copy Markdown

Hello, I'm the AEM Code Sync Bot and I will run some actions to deploy your branch and validate page speed.
In case there are problems, just click a checkbox below to rerun the respective action.

  • Re-run all PSI checks
  • Re-run failed PSI checks
  • Re-sync branch
Commits

@marissahuysentruyt
marissahuysentruyt merged commit 9bf545d into main Nov 10, 2026
9 of 10 checks passed
@marissahuysentruyt
marissahuysentruyt deleted the cpeyer-adobe-preview-lambda-deployment branch November 10, 2026 21:56

This branch was successfully deployed

1 active deployment
cpeyer-adobe-preview-lambda-deployment — 53df4cb5 Deployed Nov 10, 2026 by aem-code-sync[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants