Split cloud API reference #929
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
We'll also need to go through all anchor links to |
|
|
||
| To familiarize yourself with Redpanda Cloud API basics, see the xref:redpanda-cloud:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]. To get started using the API, try the xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Quickstart]. | ||
|
|
||
| NOTE: Redpanda Cloud uses a control plane and data plane architecture. To see the available endpoints for managing your clusters, networks, and resource groups, see the link:https://docs.redpanda.com/api/cloud-controlplane-api.html[Control Plane API Reference]. |
There was a problem hiding this comment.
@JakeSCahill I wasn't sure if I was supposed to use the .adoc extension for this link, so I kept it to .html just in case. Let me know if that should be changed
|
PR to update links: redpanda-data/cloud-docs#185 |
|
@kbatuigas (cc @mo-redpanda ), I feel like this separation is not prominent enough. It seems the only place where it's actually visible is, is in the breadcrumbs. As soon as you scroll a bit you'll immediately loose track of the fact that you are currently viewing the dataplane api. Therefore, I think this only solves a part of the problem. If someone links you the List Users docs there's no immediate way to distinguish this "Users" API from the "Controlplane Users" for example |
Description
Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline: 31 Jan
Page previews
Control Plane API
Data Plane API
Checks