Add a DevOps setup guide for the SharedServices deployment - #12
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/devops-sharedservices-setup.html— a self-contained HTML walkthrough of the one-time internal deployment setup, written for a DevOps engineer and whoever coordinates them (a contractor with limited access, per the constraint that started this).What it covers:
shared-services-infra— the static app spec values, links to the specs directory and PR-creation page, whattofu applyprovisions, and the three outputs DevOps must hand back (deploy role ARN, bucket name, distribution ID)sharedservicesGitHub environment — exact variable/secret names with what each is for in plain terms (STATIC_PREFIX → S3 slot + URL path + build PATH_PREFIX; SITE_URL → canonical URLs with the no-trailing-slash rule; OIDC explained)--deletesync, and the CloudFront invalidationLinks throughout go to the actual pages needed (repo settings → environments, the workflow dispatch page, the infra specs directory, the platform's own static contract docs, #eng-team). README's SharedServices section now links to the file.
Verification: precommit gate green (lint, typecheck, code-quality, tests). Standalone file — no build system involvement, opens in any browser.