Restructure the platform docs for the console - #1119
Closed
blkt wants to merge 4 commits into
Closed
Conversation
Documents the components Stacklok Enterprise ships that had no public documentation at all, and removes the two sections whose software is being withdrawn. New: an AI Gateway policy section (providers, routing, budgets and pricing, prompt injection screening, PCI/PII controls, audit log forwarding), an Identity and directory section (users and groups, SCIM, identity providers, managed secrets, virtual API keys), a console section split by role, and two concepts pages. Two setup pages cover enabling each gateway, both of which are off by default. Removed: Stacklok Desktop and the previous console, with permanent redirects for all 13 URLs and every inbound link fixed. Registry, source, and entry administration redirect to the ToolHive registry guides, which already document that surface. Deliberately not written: a rate-limits page (the AIGateway CRD has no rate-limit fields, so there is no configuration surface to document) and a transition page (a migration guide is out of scope, and with the product name unchanged there is nothing to transition between).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Stacked on #1118, which is stacked on #1117. Review those first; this base retargets as they merge.
Implements Phase 1 of the plan for stacklok/stacklok-enterprise-platform#3060.
What
Documents the components that ship today with no public documentation at all, and removes the two sections whose software is being withdrawn.
New sections
Removed
Stacklok Desktop (5 pages) and the previous console (7 pages), plus the Desktop policy page. All 13 URLs get permanent redirects and every inbound link is fixed, including one from the ToolHive side. Registry, source, and entry administration redirect to
toolhive/guides-registry, which already documents that surface in 18 pages.Decisions worth reviewing
rate-limitspage because theAIGatewayCRD has no rate-limit fields, so there is no configuration surface to document. There is no transition page because a migration guide is out of scope and, with the product name unchanged, there is nothing to transition between.Assumptions stated for the record
connectorGatewayDirectoryConfigMigrationis default-on by launch. Group-based connector access is documented as a live feature on that basis.workspace/directory comes out and its sidebar entry with it.Not ready to merge
This site is unversioned, so merging deletes docs for software customers are still running. This should land as one merge on launch day, not before. It is a draft for that reason as well as for review.
Verification
npm run buildsucceeds, so every internal link resolves.tsc --noEmit,prettier --check, andeslintare clean. The build output confirmsenterprise-desktopandenterprise-cloud-uiare gone and the new routes render.Screenshots are not included yet: they should be taken against the shipped console rather than a dogfood deployment, and cropped so the internal route prefix does not appear.