docs(concepts): document installation handoffs - #436
Draft
defangdevs wants to merge 1 commit into
Draft
defangdevs wants to merge 1 commit into
defangdevs wants to merge 1 commit into
Conversation
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueComment |
This branch has not been 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
createInstallationHandoffmutation, variables, response, redirect, and compatible-retry behaviorThis is a draft current-contract foundation for DefangLabs/portal#1091. It pairs with DefangLabs/samples#724.
Current vs forthcoming
Current behavior was traced against Portal
mainafter #1093 merged. The page documents only the currently merged GraphQL action, hosted setup redirect, retry semantics, automatic dispatch, and immediate status behavior.The page does not invent callback headers, signatures, machine credential fields, lifecycle states, or revocation guarantees. Those remain active work in portal#1086 and portal#1087.
Constitution gates
Testing
bash scripts/prebuild.shnpx docusaurus buildbuild/docs/concepts/installation-handoffs.htmlfor every literal endpoint, mutation, selector, redirect, issue link, and test commandnpm run typecheckremains blocked by the pre-existing unchangedsrc/components/OneClick/index.tsximport of@theme/CodeBlock. The production build succeeds. Docusaurus also reports existing broken-link warnings on unrelated FAQ, samples, migration, MCP, and AWS pages; this page adds no broken link or anchor.Dependency before production use
Keep this PR in draft until maintainers decide whether to merge the honest current-contract guide now or wait for #1086/#1087. The page itself is mergeable with samples#724; it clearly says the current developer token is suitable for attended evaluation, not an unattended production service.