remove LA and beta notes from RPCN in Cloud #345
Closed
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
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThe change removes a partial file reference for an availability message from a documentation page and deletes an extra blank line at the end of the same file. No other modifications to content, structure, or exported entities are present. Possibly related PRs
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/develop/pages/connect/about.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#334
File: modules/networking/partials/psc-api2.adoc:15-16
Timestamp: 2025-06-18T21:02:38.074Z
Learning: In the Redpanda Cloud documentation system, cross-reference anchors using the format `#patch-/v1/clusters/-cluster.id-` work correctly for referencing API endpoints, even with dashes instead of curly braces around parameter names.
Learnt from: asimms41
PR: redpanda-data/cloud-docs#291
File: modules/develop/pages/connect/components/processors/google_drive_download.adoc:1-1
Timestamp: 2025-05-13T13:20:39.044Z
Learning: In Redpanda Cloud documentation, component titles (particularly processors) follow a standard naming convention that uses underscores (like "google_drive_download") rather than human-readable titles. This convention should be maintained for consistency across all component documentation.
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
| Try this xref:develop:connect/connect-quickstart.adoc[quickstart]. | ||
|
|
||
| TIP: If you’re new to Redpanda Connect, try xref:redpanda-connect:guides:getting_started.adoc[building and testing data pipelines locally] before deploying to the Cloud. | ||
| TIP: If you’re new to Redpanda Connect, try xref:redpanda-connect:guides:getting_started.adoc[building and testing data pipelines locally] before deploying to the Cloud. |
Contributor
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify that the target file for the TIP cross-reference actually exists
The new TIP links to xref:redpanda-connect:guides:getting_started.adoc[…].
If that file was renamed or removed when the LA/Beta content was cleaned up, the docs build will fail with a broken-link warning.
🏁 Script executed:
#!/bin/bash
# Sanity-check that the referenced getting_started doc still exists
fd -c never getting_started.adoc | grep 'redpanda-connect/.*getting_started.adoc' -nLength of output: 86
Let’s locate all instances of getting_started.adoc in the repo to confirm the correct path:
🏁 Script executed:
#!/bin/bash
# List every file named getting_started.adoc in the repo
fd getting_started.adocLength of output: 25
Let’s broaden the search to catch any variant (underscore vs. hyphen) and verify under the expected directory:
🏁 Script executed:
#!/bin/bash
set -e
echo "1) All .adoc files with “getting” in the name:"
fd -e adoc "*getting*.adoc" || true
echo
echo "2) Any references to getting_started.adoc in .adoc sources:"
rg -l "getting[_-]started.adoc" --glob '*.adoc' || true
echo
echo "3) List all .adoc under connect/guides:"
fd modules/develop/pages/connect/guides -e adoc || trueLength of output: 1405
Let’s verify whether the guides directory (and the target file) actually exists, and inspect its contents:
🏁 Script executed:
#!/bin/bash
set -e
echo "1) Checking for modules/develop/pages/connect/guides directory:"
if [ -d modules/develop/pages/connect/guides ]; then
echo "→ Found; listing .adoc files:"
find modules/develop/pages/connect/guides -type f -iname '*.adoc'
else
echo "→ Directory modules/develop/pages/connect/guides not found"
fi
echo
echo "2) Subdirectories under modules/develop/pages/connect/:"
find modules/develop/pages/connect -mindepth 1 -maxdepth 1 -type d -printf " - %f\n" || true
echo
echo "3) Files directly under modules/develop/pages/connect/:"
find modules/develop/pages/connect -maxdepth 1 -type f -printf " - %f\n" || trueLength of output: 1414
Fix broken TIP cross-reference in about.adoc
The TIP in modules/develop/pages/connect/about.adoc links to a non-existent getting_started.adoc. Update it to point to the existing quickstart page:
• File: modules/develop/pages/connect/about.adoc
Line 17
Suggested change:
-TIP: If you’re new to Redpanda Connect, try xref:redpanda-connect:guides:getting_started.adoc[building and testing data pipelines locally] before deploying to the Cloud.
+TIP: If you’re new to Redpanda Connect, try xref:redpanda-connect:connect-quickstart.adoc[building and testing data pipelines locally] before deploying to the Cloud.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| TIP: If you’re new to Redpanda Connect, try xref:redpanda-connect:guides:getting_started.adoc[building and testing data pipelines locally] before deploying to the Cloud. | |
| TIP: If you’re new to Redpanda Connect, try xref:redpanda-connect:connect-quickstart.adoc[building and testing data pipelines locally] before deploying to the Cloud. |
🤖 Prompt for AI Agents
In modules/develop/pages/connect/about.adoc at line 17, the TIP cross-reference
points to a non-existent getting_started.adoc file. Update the xref link to
reference the existing quickstart page instead, ensuring the link target matches
the correct file path and name for the quickstart documentation.
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.
Description
Resolves https://github.com/redpanda-data/documentation-private/issues/2832
Review deadline:
Page previews
Checks