Skip to content

docs: drop API Connector documentation (CTP-304)#1206

Open
phisco wants to merge 1 commit into
mainfrom
ctp-304
Open

docs: drop API Connector documentation (CTP-304)#1206
phisco wants to merge 1 commit into
mainfrom
ctp-304

Conversation

@phisco

@phisco phisco commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

What

Drops the API Connector documentation entirely, per CTP-304.

API Connector was a never-completed Preview feature. With the shift from
topologies to optimising Spaces there's no intention to evolve it, and keeping
it around only confuses customers.

Changes

  • Pages: removed api-connector.md from current cloud-spaces and
    self-hosted-spaces docs, plus the 1.13–1.16 versioned snapshots.
  • Sidebars: removed the howtos/api-connector entry (current + 1.13–1.16).
  • CLI reference: removed the up controlplane api-connector reference pages
    and their imports/sections in cli-reference.md.
  • Cross-references: removed the dead (defined-but-unused) [api-connector]
    link definitions from the MCP connector guides and the two llms.txt entries.
  • Image: deleted the now-orphaned static/img/api-connector.png.
  • Redirects (vercel.json): repointed /operate/api-connector and added a
    redirect for the now-deleted live page /self-hosted-spaces/howtos/api-connector,
    both → ctp-connector (matching the existing convention for old connector paths).

Left intentionally

  • The historical "Introduced up api-connector CLI…" line in the up CLI release
    notes — kept as an accurate record of a past release.
  • Per-version URLs (e.g. /self-hosted-spaces/1.16/howtos/api-connector) will now
    404; given this was an incomplete preview feature I didn't add per-version
    redirects. Happy to add them if you'd prefer.

Verification

npm run build passes; no api-connector references or broken links remain (the
only build warnings are pre-existing and unrelated).

Closes CTP-304.

API Connector was a never-completed Preview feature. With the shift from
topologies to optimising Spaces there's no intention to evolve it, and
keeping it around only confuses customers — so remove it from the docs
entirely.

- Delete the API Connector how-to from current cloud-spaces and
  self-hosted-spaces docs and from the 1.13-1.16 versioned snapshots
- Remove the sidebar entries (current + versioned)
- Drop the `up controlplane api-connector` CLI reference pages and their
  imports/sections in cli-reference.md
- Remove the dead [api-connector] link definitions from the MCP connector
  guides and the two llms.txt entries
- Delete the orphaned api-connector.png image
- Repoint /operate/api-connector and add a redirect for the now-deleted
  /self-hosted-spaces/howtos/api-connector page, both to ctp-connector

Signed-off-by: Philippe Scorsolini <5697904+phisco@users.noreply.github.com>
@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 25, 2026 4:28pm

Request Review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 29a187cca8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread vercel.json
"permanent": true
},
{
"source": "/self-hosted-spaces/howtos/api-connector(/)?",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add redirects for versioned API Connector pages

This redirect only covers the unversioned self-hosted URL, but the same patch deletes the API Connector docs from the 1.13–1.16 versioned snapshots as well. Users following existing versioned docs links such as /self-hosted-spaces/1.16/howtos/api-connector will now get a 404 even though the corresponding /self-hosted-spaces/1.16/howtos/ctp-connector page still exists, so add per-version redirects or keep those versioned pages.

Useful? React with 👍 / 👎.

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