Skip to content

Exchange: rewrite the docs from FORA Server and add them to the sidebar - #85

Open
EugeneDymo wants to merge 2 commits into
mainfrom
docs/updating-exchange-docs
Open

EugeneDymo wants to merge 2 commits into
mainfrom
docs/updating-exchange-docs

Conversation

@EugeneDymo

Copy link
Copy Markdown
Member

The eight Exchange pages described an earlier design rather than FORA Server: DynamoDB, ClickHouse, a WAL, a config file, hot reload, gRPC health, per-tenant keys and latency targets. They were also off the sidebar.

The overview now follows one resource through FORA Server's Exchange: how a catalog push is accepted, how offers are selected and signed, how a purchase is charged and recorded, what the usage report rules are, how an agent opens an account, how each request is verified, and what an operator runs. The billing page is now Billing and Ledgers. It states the real adapter contract, the three ledgers, currencies, identifiers, the charging flow, free and subscription items, fees and publisher revenue, and failure handling.

Request Flows, Configuration, Storage Model, Multi-Tenant, Scaling and Health Checks are retired, and their URLs redirect to the overview. The sidebar has an Exchange group with Overview and Billing and Ledgers.

FORA for Exchange Operators is corrected against the same code, and notes where FORA Server's Exchange does not follow a protocol rule.

The eight Exchange pages described an earlier design rather than FORA
Server: DynamoDB, ClickHouse, a WAL, a config file, hot reload, gRPC
health, per-tenant keys and latency targets. They were also off the
sidebar.

The overview now follows one resource through FORA Server's Exchange:
how a catalog push is accepted, how offers are selected and signed, how
a purchase is charged and recorded, what the usage report rules are, how
an agent opens an account, how each request is verified, and what an
operator runs. The billing page is now Billing and Ledgers. It states
the real adapter contract, the three ledgers, currencies, identifiers,
the charging flow, free and subscription items, fees and publisher
revenue, and failure handling.

Request Flows, Configuration, Storage Model, Multi-Tenant, Scaling and
Health Checks are retired, and their URLs redirect to the overview. The
sidebar has an Exchange group with Overview and Billing and Ledgers.

FORA for Exchange Operators is corrected against the same code, and
notes where FORA Server's Exchange does not follow a protocol rule.
…ws page

TestDocHandlerExampleCompiles pinned the DiscoverResources handler
example of the Exchange request-flows page to
conformance/docgo/requestflows. The page is retired and redirects to the
Exchange overview, so the test had no page to read and failed.

The example went with the page: it showed a handler design against
stubs, not FORA Server's handler. Remove the test, the package it
generated, and the comment that mentioned the example.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant