Migrate Cloud API docs #4
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kbatuigas
force-pushed
the
DOC-1467-refactor-cloud-api-docs
branch
from
704642a to
506eaba
Compare
JakeSCahill
approved these changes
Jul 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant updates to the Redpanda Cloud API documentation, including restructuring topics, renaming files, and adding new content. The changes focus on improving clarity and providing detailed guidance for both the Control Plane and Data Plane APIs. The most important changes include the addition of new topics, renaming and updating existing files, and aligning references in configuration files.
New Documentation Topics:
long-running-operations.mdto explain asynchronous operations in the Control Plane API, including best practices and example responses.quickstart.mdfor both Control Plane and Data Plane APIs, providing step-by-step guides for authentication and resource creation. [1] [2]cloud-api-overview.mdto describe the architecture, base URLs, and versioning for the Redpanda Cloud API.File Renaming and Updates:
controlplane-api-error-and-status-codes.mdtoerror-and-status-codes.mdand updated its title to "Control Plane API Error and Status Codes."dataplane-api-error-and-status-codes.mdtoerror-and-status-codes.mdand updated its title to "Data Plane API Error and Status Codes," along with minor content updates. [1] [2]Configuration File Updates:
add-x-topics.yamlfor bothcloud-controlplaneandcloud-dataplaneoverlays to include new and renamed topics, ensuring proper references. [1] [2]