Repository navigation
docs(user-docs): Mecatl Studio web UI deployment page - #1765
Merged
Merged
Conversation
samuv
added this pull request to stack #1766
September 22, 2026 08:01
samuv
force-pushed
the
studio/user-docs
branch
from
September 22, 2026 09:04
ab27f11 to
ca6c798
Compare
samuv
force-pushed
the
studio/user-docs
branch
from
September 22, 2026 09:13
ca6c798 to
6acccf2
Compare
samuv
force-pushed
the
studio/user-docs
branch
from
September 22, 2026 09:23
6acccf2 to
aecb550
Compare
samuv
force-pushed
the
studio/user-docs
branch
from
September 22, 2026 09:59
aecb550 to
b5b8f75
Compare
This was referenced Sep 22, 2026
samuv
force-pushed
the
studio/user-docs
branch
from
September 23, 2026 08:56
b5b8f75 to
019def6
Compare
samuv
force-pushed
the
studio/user-docs
branch
from
September 23, 2026 09:41
019def6 to
d6924b6
Compare
samuv
force-pushed
the
studio/user-docs
branch
from
September 23, 2026 10:47
d6924b6 to
254a2ad
Compare
samuv
force-pushed
the
studio/user-docs
branch
from
September 23, 2026 11:54
254a2ad to
2c8bc53
Compare
The top layer of the Studio stack. Adds building/deployment/studio.md, owning the signed ghcr.io/stacklok/mecatl/studio image, what Studio offers per deployment capability, the local Compose quick start, the mecak8s deployment with OIDC browser login (public URL, session secret, trusted proxy hops, resource URL), the static-token and no-auth opt-in, the environment reference, and troubleshooting for discovery and sign-in loops. Linked from the deployment overview, the intro, the install page's deployment artifacts, and registered as the canonical page in the authoring contract. This closes the AGENTS.md same-PR documentation rule at stack granularity, as docs/acceptance/studio-bootstrap.md recorded. Verified: task site:build and task docs pass. Tracking: #1736 Signed-off-by: Samuele Verzi <samu@stacklok.com> The page opens with an early-access warning: the interface, the /api/v1 endpoints, the configuration, and the browser-stored data can change in any release with no deprecation period, so deployments pin an exact tag rather than latest. The deployment index, the intro, and the install page label the entry the same way, and the image carries org.stacklok.mecatl.studio.stability=early-access so a deployment can assert on it.
samuv
force-pushed
the
studio/user-docs
branch
from
September 23, 2026 12:54
2c8bc53 to
3449fdb
Compare
This branch was successfully deployed
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.
Summary
Adds
user-docs/building/deployment/studio.md: the signedghcr.io/stacklok/mecatl/studioimage, what Studio offers per deployment capability, the local Compose quick start, themecak8sdeployment with OIDC browser login (public URL, session secret, trusted proxy hops, resource URL), the static-token and no-authentication opt-in, the environment reference (including the two activity-replay boundsSTUDIO_ACTIVITY_REPLAY_MAXandSTUDIO_ACTIVITY_MAX_STREAMS), and troubleshooting. Linked from the deployment overview, the intro, and the install page, and registered as the canonical page inuser-docs/_README.md.This layer closes the same-PR documentation rule at stack granularity, as
docs/acceptance/studio-bootstrap.mdrecorded.Verification
task site:buildandtask docspass.Early access
The page opens with a warning that Studio is early access: its interface,
/api/v1endpoints, configuration, and browser-stored data can change in any release with no deprecation period, so deployments should pin an exact tag rather thanlatest. The deployment index, the intro, and the install page label the entry the same way.Further amendments
MECATL_RESOURCE_URLis now described as the canonical resource identifier that must equal the publishedresource, with a troubleshooting entry forauth_discovery_invalid.421 Host not allowedanswer, and the page says the ingress must pass the originalHostthrough.STUDIO_HOST, and the rate-limit row describes what is actually counted.cosign verifyandgh attestation verifycommands, instead of linking a workflow README that had none.apps/README.mdnow covers only local development and links the public page for deployment, configuration, the image, and security. This also removes a stale description of the CSRF rule.Development stage
Contract linkage
gh stack) delivery for the whole Studio series: nothing merges until every layer is reviewed, so the plan's approval-by-merge event is deferred to the end (recorded in each plan's Delivery line), and each implementation layer records the exact plan commit it built against.user-docs/page is the recorded top layer of the stack (seedocs/acceptance/studio-bootstrap.md, Human decisions)Interface conformance
Issue relationship
Relates to #1752 (parent #1736; stack #1766). Non-closing: the step completes when both of its layers merge.
Type of change
Test plan
Baseline checks
task lint)task test)go run ./cmd/mecademo)task docs)task site:build)User-facing change
A new documentation page: Mecatl Studio web UI (deployment).
Special notes for reviewers
Part of a fourteen-layer stack; review bottom-up. Nothing merges until the whole series is reviewed.