Repository navigation
Docs/publisher onboarding flow - #60
Merged
Merged
Conversation
The page promised two parts, while the console opens on naming the business and then sets up a domain in three steps that can wait. The "How do you configure it?" block now names all four and says only the first is required; its two tasks read as the console's last step names them. The register block says the same on its own, because it shows before any preview has drawn the block it used to call "above". The price reads "per fetch" as it does in the console, and the register block no longer says the file and the package carry the publisher's terms: neither does.
… origin The edge pages described an edge function that generates, caches and serves both documents, from the Exchange, from KV or from its own settings, and that serves ACME challenge tokens written by a CLI. None of that exists. The edge forwards exactly those two paths to the provider's own origin for every client, ahead of all its checks, and keeps no copy, so the file an agent is sent to, the file an Exchange reads and the file the provider edits are one file. overview.mdx now holds that statement, and the other pages link to it. deployment.mdx loses the token, serving-mode and caching sections, the settings that only fed an edge-built document, and the `fora init` onboarding diagram. The adapter interface and the CloudFront sample stop carrying the documents. The fora.json rate limit is a platform rule in front of the edge, kept above the rate an Exchange reads the file. X-Content-Rules is built from the refused request's host, not from configuration, and the deployment page now says so.
The guide listed five steps that no longer exist and said nothing is saved until the last button. The console now opens on Your business, which is required and asked once, then sets up a domain in Your domain, Your terms and Connect your site, which save on each Next and can be finished later. Every further domain takes those three. The guide follows that order screen by screen, with a section each for Finish later and for adding another domain, and uses the console's own words. It calls the artifact the discovery file throughout. The package no longer serves the file or the RSL document, so the sentences that said so are gone. Keys and your catalog now says the file on the publisher's site is the document: editing it is how they change who may sell or import their pages, nothing needs redeploying, and it names what a change can break.
…nge pages
The provider, operator and architecture pages presented a token
challenge run by a CLI as how a domain is proven and a key provisioned.
Domain control is proven by the fora.json the domain serves, which the
Exchange reads at registration, on each check and at each catalog push.
The contract's two RPCs stay, and the pages say so: they are for
deployments that verify with a challenge instead.
Because the file lives on the provider's origin, the managed model can
no longer promise the provider has nothing to do, so those pages name the
one file the provider publishes. The Exchange pages lose the
/provider/{domain}/ document endpoints, whose only reader was an edge
that fetched them; the generated RSL is published on the origin instead.
…ments The comments on RequestDomainVerification and on the Provider Domain Verification section named a fora-cli tool that does not exist and said an edge function can auto-serve the challenge token from a KV store, which none does. The published reference prints the RPC's comment from the descriptor, so this is the only place to correct it. The contract does not change: comments only, regenerated, with no new rule. The challenge still has the provider place the token at the same address.
…files The public page and the guide follow the console by hand, so a website test now holds both to its step names, the two tasks of its last step, and both step counts, and refuses the names it retired. The doc conformance gate refuses the retired claims: serving modes, the Exchange document endpoints, the CLI and the edge store for challenge tokens. fora-verify stays legal because the contract's messages name it. The design history gains the reasoning behind the edge passing a publisher's documents through, and marks the older section it replaces. Both changelogs carry the change under Unreleased.
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.
Why
The public page, the publisher guide and the edge pages described flows that no longer exist. The console's setup was rebuilt, and the edge no longer serves a publisher's documents.
What changes
fora.jsonandrsl.txtare files on the publisher's origin, and the edge forwards both for every client. The serving modes, the caching strategy and the ACME token flow are gone.fora.jsonit serves. The/provider/{domain}/document endpoints are removed, and the managed-model pages say the provider publishes one file.fora.proto: comments only. They no longer namefora-clior an edge KV store, so the published reference stops naming them too.docs/design-history.mdrecords why the documents live on the origin.For reviewers
RequestDomainVerificationandConfirmDomainVerificationstay in the contract and the reference pages.@fora/*tooling, the Terraform blocks with their dead links, and the Fastly and Akamai cards on the public page.