Conversation
Document Redpanda Console unlimited pagination for browsing topic messages and Redpanda Connect pipeline events. Uses single-source pattern with ifdef::env-cloud[] conditional xrefs so the page renders correctly in both the Self-Managed and Cloud docs sites. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Must be reverted before merge. Allows the cloud-docs stub page at modules/develop/pages/consume-data/paginate-messages-events.adoc to resolve against this docs PR branch when rendering the cloud-docs deploy preview. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR modifies documentation and configuration to introduce a new how-to guide for paginating messages and events in the Redpanda Console UI. The change updates the Antora playbook to fetch content from a different branch of the cloud-docs repository, adds a navigation entry, updates an existing cross-reference, and introduces a new documentation page with step-by-step pagination instructions, conditional environment-specific content, and performance considerations for UI and cluster operations. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
modules/ROOT/nav.adoc (1)
52-52: Consider using empty brackets for automatic title resolution.The xref includes hard-coded link text
[Paginate Messages and Events]. Per AsciiDoc best practices, prefer using empty brackets[]to automatically pull the title from the target document.However, I notice that many other navigation entries in this file also use custom link text (e.g., lines 50-51), likely for brevity in the navigation menu. If custom text is intentional for UX purposes, this is acceptable.
♻️ Proposed change to use automatic title resolution
-*** xref:console:ui/paginate-messages-events.adoc[Paginate Messages and Events] +*** xref:console:ui/paginate-messages-events.adoc[]Based on learnings: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/ROOT/nav.adoc` at line 52, Replace the hard-coded xref link text in the nav entry "xref:console:ui/paginate-messages-events.adoc[Paginate Messages and Events]" with empty brackets to enable automatic title resolution (change to xref:console:ui/paginate-messages-events.adoc[]); if the custom short label was intentional for navigation UX, leave it as-is but otherwise use the [] form consistently with other entries.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@local-antora-playbook.yml`:
- Line 21: The playbook currently sets the Antora source branch to the feature
branch via the YAML key `branches: 'DOC-1907-paginate-messages-events'`; update
that `branches` value to `main` in local-antora-playbook.yml (replace the string
assigned to the `branches` key) so the `cloud-docs` source points back to the
main branch before merging.
---
Nitpick comments:
In `@modules/ROOT/nav.adoc`:
- Line 52: Replace the hard-coded xref link text in the nav entry
"xref:console:ui/paginate-messages-events.adoc[Paginate Messages and Events]"
with empty brackets to enable automatic title resolution (change to
xref:console:ui/paginate-messages-events.adoc[]); if the custom short label was
intentional for navigation UX, leave it as-is but otherwise use the [] form
consistently with other entries.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f4c4f4a4-0e4a-4ee5-a781-4fa3727e0967
📒 Files selected for processing (4)
local-antora-playbook.ymlmodules/ROOT/nav.adocmodules/console/pages/index.adocmodules/console/pages/ui/paginate-messages-events.adoc
| branches: [v/*, shared, site-search,'!v-end-of-life/*'] | ||
| - url: https://github.com/redpanda-data/cloud-docs | ||
| branches: 'main' | ||
| branches: 'DOC-1907-paginate-messages-events' |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify cloud-docs branch reference is set to 'main'
# Check the cloud-docs branch configuration
grep -A1 "url: https://github.com/redpanda-data/cloud-docs" local-antora-playbook.yml | grep "branches:"Repository: redpanda-data/docs
Length of output: 111
Revert cloud-docs branch reference to main before merging.
The cloud-docs source is currently pointing to the feature branch DOC-1907-paginate-messages-events (set for Netlify preview). Line 21 of local-antora-playbook.yml must be updated to branches: main as indicated in the PR checklist before this PR can be merged.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@local-antora-playbook.yml` at line 21, The playbook currently sets the Antora
source branch to the feature branch via the YAML key `branches:
'DOC-1907-paginate-messages-events'`; update that `branches` value to `main` in
local-antora-playbook.yml (replace the string assigned to the `branches` key) so
the `cloud-docs` source points back to the main branch before merging.
|
|
||
| == Paginate topic messages | ||
|
|
||
| When you browse a topic in {ui}, the *Messages* tab returns an initial batch of records. To retrieve additional records beyond this batch: |
There was a problem hiding this comment.
On this one, i think the behaviours aren't matching, the retrieval of more than 500 messages we only applied to messages, pipeline events got a different experience if im not wrong.
To browse a topic past 500 we have a toggle on the UI called continuous pagination. Toggling this allows users to keep paginating
There was a problem hiding this comment.
Thanks @c-julin! I'll narrow this page to topic messages only. I don’t see the continuation pagination toggle. Could you share either a link to a cluster where it's visible or a screenshot of it? I'm assuming it only appears once a topic has more than 500 messages?
Pipeline-events pagination is covered in a separate PR, so remove the pipeline-events section, trim the intro/description/performance bullet, and switch the nav entry to empty brackets per CodeRabbit nitpick. The topic-messages section body is unchanged pending reviewer clarification on the continuous pagination toggle. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
micheleRP
changed the title
2 participants
Resolves https://redpandadata.atlassian.net/browse/DOC-1907
Description
Documents Redpanda Console's unlimited pagination feature (ENG-971), which lets users retrieve more than 500 messages when browsing topic messages.
modules/console/pages/ui/paginate-messages-events.adocas the single-source page (wrapped in// tag::single-source[]tags so cloud-docs can include it)Preview pages
Dependencies
Before merge
local-antora-playbook.ymlso thecloud-docssource points back to'main'instead of'DOC-1907-paginate-messages-events'Checks