Skip to content

docs(infrastructure): New AWS frontend PrivateLink doc, restructuring#10908

Merged
bsod90 merged 1 commit into
masterfrom
frontend_private_link_doc
May 19, 2026
Merged

docs(infrastructure): New AWS frontend PrivateLink doc, restructuring#10908
bsod90 merged 1 commit into
masterfrom
frontend_private_link_doc

Conversation

@bsod90
Copy link
Copy Markdown
Member

@bsod90 bsod90 commented May 19, 2026

Check List

  • Tests have been run in packages where changes have been made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet
  • Docs have been added / updated if required

@bsod90 bsod90 requested a review from keydunov as a code owner May 19, 2026 17:43
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 19, 2026

Claude finished @bsod90's task in 2m 20s —— View job


Review: docs(infrastructure) — New AWS frontend PrivateLink doc, restructuring

  • Gather context and read all changed files
  • Review navigation structure (docs.json)
  • Review new private-api-connectivity.mdx content
  • Review renamed/modified index files
  • Review renamed BYOC files and redirects
  • Post comprehensive review

Summary

This PR consolidates the previously separate "VPC" and "BYOC" doc sections into a single Dedicated Infrastructure hierarchy under /admin/deployment/vpc/, adds a substantial new Private API Connectivity doc for AWS, and wires up redirects for all old paths. The restructuring is clean and the new document is thorough. A few items to address below.


What looks good

  • Unified information architecture. Merging BYOC docs under each cloud provider rather than maintaining a parallel /byoc/ tree is a good call — users think "I'm on AWS" not "I want BYOC vs VPC". The navigation now reflects that.
  • Comprehensive redirects. All deleted/moved paths have corresponding entries in docs.json redirects, which should prevent broken external links.
  • New Private API Connectivity doc. The explanation of the three client classes (app servers, browsers, BI tools) and why the private hostname must be VPN-routable is excellent — this is the kind of operational context that's hard to find elsewhere.
  • Link fixes. The old AWS index referenced /docs/deployment/cloud/vpc/... paths (wrong base path); the new version uses the correct /admin/deployment/vpc/... paths.

Issues and suggestions

1. Placeholder content left in — screenshots not attached

private-api-connectivity.mdx lines 116–122 contain two empty <Frame> tags with JSX comments:

<Frame>
  {/* Screenshot of admin → Regions → "Region" domain field to be attached */}
</Frame>

<Frame>
  {/* Screenshot of the per-deployment private endpoint detail to be attached */}
</Frame>

These will render as empty frames in the published docs. If the screenshots aren't ready yet, consider either removing these blocks until the images are available or adding a visible <Info> note saying they're coming.

Similarly, lines 69–74 contain:

<Info>
A higher-fidelity Lucidchart diagram of this topology will replace the mermaid
sketch above.
</Info>

If this is shipping to production, the TODO notes should probably be removed or gated behind a comment that doesn't render.

2. Missing newline at end of file (minor)

These files are missing a trailing newline:

  • docs-mintlify/admin/deployment/vpc/azure/index.mdx
  • docs-mintlify/admin/deployment/vpc/gcp/index.mdx
  • docs-mintlify/docs.json

Not a functional issue, but it produces \ No newline at end of file warnings in diffs and is a common source of noise in future commits.

3. Mermaid diagram rendering — verify on Mintlify

The mermaid diagram in private-api-connectivity.mdx (lines 38–67) uses flowchart LR with subgraphs. Worth verifying this renders correctly on Mintlify — some Mintlify versions have limited mermaid support (particularly with complex subgraph layouts and styled edge labels like -.PrivateLink.->).

4. The old private-link.mdx covered datasource-side PrivateLink — that content is now gone

The deleted vpc/aws/private-link.mdx described setting up PrivateLink for connecting Cube Cloud to your data sources (customer creates an Endpoint Service, Cube connects to it). The new private-api-connectivity.mdx covers the opposite direction — connecting your apps to Cube Cloud APIs.

These are two different use cases:

  • Old doc (deleted): Cube → your datasource over PrivateLink (you expose an endpoint service, Cube creates a VPC endpoint)
  • New doc: Your apps → Cube APIs over PrivateLink (Cube exposes endpoint services, you create VPC endpoints)

The redirect from /admin/deployment/vpc/aws/private-link/admin/deployment/vpc/aws/private-api-connectivity will send users looking for datasource-side PrivateLink instructions to a page about API-side PrivateLink, which covers a different scenario. Consider either:

  • Keeping the datasource-side PrivateLink content (perhaps as a section in the VPC peering doc or a separate page), or
  • Adding a brief note in the new doc about datasource connectivity being handled via VPC Peering, if that's the current recommendation.

5. Azure/GCP parity note

The Azure and GCP index pages now mention BYOC, which is great. However, the Azure index still links to azure/private-link (datasource-side Private Link), which creates an asymmetry: AWS has "Private API Connectivity" (API-side) while Azure has "Private Link" (datasource-side). This isn't necessarily a problem if Private API Connectivity is AWS-only for now, but it may be worth a one-line note on the Azure page clarifying that private API connectivity is coming or is AWS-only.


Verdict

The restructuring and new content are strong. The main concern is item #4 — the deleted datasource-side PrivateLink content and the potentially misleading redirect. The placeholder images/diagrams (item #1) should also be resolved before shipping. Everything else is minor.

@bsod90 bsod90 force-pushed the frontend_private_link_doc branch from 16957f7 to b8afe98 Compare May 19, 2026 20:48
@bsod90 bsod90 merged commit 08c2376 into master May 19, 2026
8 checks passed
@bsod90 bsod90 deleted the frontend_private_link_doc branch May 19, 2026 20:53
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