Skip to content

Make API Explorer and cookbook auth usable without guessing instance names - #699

Merged
chris-freeman-glean merged 1 commit into
mainfrom
cfreeman/pact-538-docs-cookbook-usability
Aug 20, 2026
Merged

Make API Explorer and cookbook auth usable without guessing instance names#699
chris-freeman-glean merged 1 commit into
mainfrom
cfreeman/pact-538-docs-cookbook-usability

Conversation

@chris-freeman-glean

Copy link
Copy Markdown
Contributor

Summary

  • First-time API Explorer users could not tell the Base URL was a template, and Finding Your Server URL never said what to copy or who to ask if they are not an admin.
  • Explorer default is now https://{instance-name}-be.glean.com with a server description pointing at About → Server instance (QE). Auth overview copy matches.
  • Cookbook pages now keep a sticky Auth card that links token/OAuth docs instead of saying "get a token" with no how. Registry snapshot includes the companion cookbook prereq copy (glean-cookbook#46).

Fixes PACT-538.

Test plan

  • Open any REST API Explorer page: Base URL shows braces; description mentions About → Server instance
  • Paste a QE URL from About; Try it out no longer treats it as a placeholder
  • Read Finding Your Server URL: concrete example, copy-the-full-URL, non-admin fallback
  • Open a no-code cookbook recipe: rail Auth card + Token Management prereq
  • Open the email-draft agent recipe: rail must not tell you to mint a Glean token
  • pnpm test and FF_COOKBOOKS=true pnpm build

@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
glean-developer-site Ready Ready Preview Aug 20, 2026 5:15pm

Request Review

@chris-freeman-glean
chris-freeman-glean marked this pull request as ready for review August 20, 2026 17:06
@chris-freeman-glean
chris-freeman-glean requested a review from a team as a code owner August 20, 2026 17:06
…names.

Show Base URL as a template with About-page help, spell out how to copy Server instance (QE), and add a recipe-rail Auth card that links to token docs.
@chris-freeman-glean
chris-freeman-glean force-pushed the cfreeman/pact-538-docs-cookbook-usability branch from 3824090 to cea0c33 Compare August 20, 2026 17:14
@chris-freeman-glean
chris-freeman-glean enabled auto-merge (squash) August 20, 2026 17:14
@chris-freeman-glean
chris-freeman-glean merged commit 33844d3 into main Aug 20, 2026
4 checks passed
@chris-freeman-glean
chris-freeman-glean deleted the cfreeman/pact-538-docs-cookbook-usability branch August 20, 2026 17:16
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.

2 participants