Refresh Preview Environments docs for the new mass environment preview#197
Merged
Conversation
The existing Applications/Preview Environments overview referenced
commands and config shapes that no longer exist (`mass preview init`,
`mass preview deploy`, `preview.json` with `projectSlug` / `packages` /
`artifactId`, `releaseStrategy`). Replace it with a current walkthrough
of `mass environment preview`:
- The four-step converge model (fork → defaults → instance overrides →
deploy) and what idempotency buys you.
- Full config schema using V2 terminology: project (not slug), instances
(not packages), resourceId (not artifactId), no `massdriver/` scoping.
- Environment-variable expansion (`${GITHUB_PR}` etc.) for piping CI
metadata into the config.
- Attributes for ABAC-gated environments.
- A drop-in GitHub Actions workflow.
Plus cross-links from the Projects & Environments concept page and the
GitHub Actions CI/CD page so readers discover preview environments
while they're working through the concepts and CI guides, not only
when they hit the CLI reference.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The previous example named `awsekscluster` as the host of `remoteReferences`, which reads backwards (a cluster producer overriding its own output). A remote reference sits under the *consumer* instance and `field` names a key in that consumer's `connections_schema`. Switched the example to a clear consumer and added a dedicated "Shared infrastructure with remote references" section that spells out the direction and both `resourceId` formats: UUID for imported resources, `<instance-id>.<field>` for another instance's provisioned output. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Env identifiers must match `^[a-z0-9]{1,20}$` — lowercase alphanumeric
only, no dashes. The full stored id is `<project>-<env>`, where the
dash is a *segment separator*, not part of the env identifier itself.
The overview's previous `pr-123` / `pr-${GITHUB_PR}` examples would be
rejected by the API. Replaced with `pr123` / `pr${GITHUB_PR}`, plus an
inline call-out under Quickstart and a note in the CI workflow.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
`/cli/commands/mass_environment_preview` doesn't exist yet — that subcommand-level page is auto-generated from the CLI repo and only lands once the corresponding CLI PR merges and the docs sync runs. Point at the parent `/cli/commands/mass_environment` with a note about the `preview` subcommand. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
The Applications / Preview Environments overview was several CLI generations out of date — referenced
mass preview init,mass preview deploy,preview.jsonwithprojectSlug/packages/artifactId, andreleaseStrategy, none of which exist anymore. This PR rewrites it around the currentmass environment previewflow (see mass#236) and adds cross-links from the Projects & Environments concept and GitHub Actions CI guide so readers discover preview environments while working through concepts and CI, not only when they hit the CLI reference.What lands
docs/applications/preview_environments/00-overview.md— full rewrite.project(no "slug"),instances(no "packages"),resourceId(no "artifactId"), nomassdriver/scoping prefix.attributessupport for ABAC-gated environments.${VAR}/$VARexpansion for piping CI metadata into the config.field) and bothresourceIdformats (UUID and<instance-id>.<field>).docs/concepts/03-projects-and-environments.md— link the existing "preview environments" mention to the new overview and add it to Related Documentation.docs/platform-operations/ci-cd/01-github.md— short pointer at the bottom for teams reading the CI/CD guide.Test plan
yarn build(or your local Docusaurus build) to confirm no broken links./applications/preview_environments/overviewrenders and the new cross-links resolve.