Skip to content

docs(quick-start): clarify the endpoint token file and org-owned auth failures - #166

Merged
minekube-ai-engineer[bot] merged 1 commit into
mainfrom
docs/endpoint-token-clarification
Sep 13, 2026
Merged

minekube-ai-engineer[bot] merged 1 commit into
mainfrom
docs/endpoint-token-clarification

Conversation

@minekube-ai-engineer

Copy link
Copy Markdown
Contributor

Source: Discord ask-support thread

Source: Discord ask-support thread — the exact thread this report came from. Kanban card: t_e7369f61. Code counterpart: minekube/connect-java#162.

Problem

The "Endpoint Token" tip in the quick start was the only docs surface for Watch auth failures, and it said:

If your get an authentication error from the Watch service, then try to reset the token in the Dashboard and update it in your connect.json / token.json file of your Connector.

Three gaps, all of which cost a user hours on an org-owned endpoint:

  1. A dashboard reset invalidates the previous token, so a connector still holding the old one keeps failing with the same error — "reset the token" alone reads like a fix, and users loop.
  2. It never says the token must go into the Connector's token file and not the config that holds the endpoint name — a token pasted into plugins/connect/config.yml is simply ignored.
  3. It never says the copy must be byte-identical (a trailing space or newline is a different token), nor that an org-owned name only accepts a token created for it inside the owning organization.

It also had the typo "If your get".

Change

  • docs/guide/quick-start.md — rewrote the Endpoint Token tip: resetting invalidates the previous token; the token belongs in the Connector token file (connect.json for Gate, token.json for the Java Plugin) or CONNECT_TOKEN, never the config that holds the endpoint name; copy byte-for-byte; and the org-owned case (a token from another organization or for another endpoint name is rejected with the same error and cannot take the name over). Typo fixed.
  • docs/guide/connectors/plugin.md — new Endpoint Token section spelling out the plugins/connect/config.yml (name) vs plugins/connect/token.json / CONNECT_TOKEN (token) split, since the connector guide is where the name is documented.
  • scripts/check-docs.mjs — content contract for the new wording plus a assertNotIncludes guard for the old "If your get" typo and for the org-switching instruction, so this guidance cannot silently regress.

Evidence

  • Guards first: against the pristine docs, node scripts/check-docs.mjs exits 1 — docs/guide/quick-start.md is missing required docs coverage: Resetting the token in the. With the docs change: Docs content assertions passed.
  • Docs job (install + yarn check:docs + changelog Chrome layout check) runs in this PR's CI.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying connect-minekube with  Cloudflare Pages  Cloudflare Pages

Latest commit: 947a1fb
Status: ✅  Deploy successful!
Preview URL: https://f17171a8.connect-minekube.pages.dev
Branch Preview URL: https://docs-endpoint-token-clarific.connect-minekube.pages.dev

View logs

@minekube-ai-engineer
minekube-ai-engineer Bot merged commit ec8ac0b into main Sep 13, 2026
7 checks passed
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.

0 participants