Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split cloud API reference #929

Draft
wants to merge 4 commits into
base: api
Choose a base branch
from

Conversation

kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Dec 17, 2024

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

Control Plane API
Data Plane API

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Copy link

netlify bot commented Dec 17, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 316d6c1
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/6765b0784b79910008e0288b
😎 Deploy Preview https://deploy-preview-929--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JakeSCahill
Copy link
Contributor

We'll also need to go through all anchor links to api:ROOT:cloud-api.adoc and change them to go to either the data plane or control plane docs.


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].
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@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

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