-
Notifications
You must be signed in to change notification settings - Fork 50
DOC-1907: Add Paginate Messages page #1673
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
Merged
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
296fb7e
DOC-1907: Add Paginate Messages and Pipeline Events page
micheleRP 301daf5
[TEMP] Point cloud-docs source to DOC-1907 branch for preview
micheleRP 74668a2
DOC-1907: Narrow scope to topic messages only
micheleRP 8eabc46
update with Julin's feedback
micheleRP 6f26ee2
Update modules/console/pages/ui/paginate-messages-events.adoc
micheleRP f4855c8
incorporate review feedback
micheleRP 09f19c8
revert playbook
micheleRP File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| = Paginate Messages in {ui} | ||
| :description: Enable Continuous Pagination on a topic's Messages tab to scroll through all records instead of being capped by Max results. | ||
| :page-topic-type: how-to | ||
|
|
||
|
|
||
| // tag::single-source[] | ||
|
|
||
| By default, the *Messages* tab on a topic returns up to the number of records set in *Max results*. Enable *Continuous Pagination* when you need to inspect a topic beyond that cap. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
|
|
||
| == Browse all messages in a topic | ||
|
|
||
| . In the menu, go to *Topics* and select a topic. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
| . Open the *Messages* tab. | ||
| . (Optional) Set *Start offset* and *Max results*, or apply filters, to narrow the records you want to inspect. | ||
| + | ||
| ifdef::env-cloud[] | ||
| See xref:manage:schema-reg/programmable-push-filters.adoc[] and xref:manage:schema-reg/record-deserialization.adoc[]. | ||
| endif::[] | ||
| ifndef::env-cloud[] | ||
| See xref:console:ui/programmable-push-filters.adoc[] and xref:console:ui/record-deserialization.adoc[]. | ||
| endif::[] | ||
| . Enable the *Continuous Pagination* toggle. | ||
| . Scroll the message list. {ui} keeps loading records until you reach the end of the topic. | ||
|
|
||
| When continuous pagination is on, the max results cap no longer limits the browsing session. | ||
|
|
||
| == Performance considerations | ||
|
|
||
| Retrieving large result sets increases load on the {ui} backend and the cluster. To keep responses fast: | ||
|
|
||
| * Narrow the result set with filters or a bounded offset range before enabling continuous pagination*. | ||
|
micheleRP marked this conversation as resolved.
Outdated
|
||
| ifdef::env-cloud[] | ||
| * Use xref:manage:schema-reg/programmable-push-filters.adoc[JavaScript push filters] to match only the records you need. | ||
| endif::[] | ||
| ifndef::env-cloud[] | ||
| * Use xref:console:ui/programmable-push-filters.adoc[JavaScript push filters] to match only the records you need. | ||
| endif::[] | ||
| * Leave continuous pagination off and rely on max results when you only need a sample. | ||
|
|
||
| // end::single-source[] | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: redpanda-data/docs
Length of output: 111
Revert
cloud-docsbranch reference tomainbefore merging.The
cloud-docssource is currently pointing to the feature branchDOC-1907-paginate-messages-events(set for Netlify preview). Line 21 oflocal-antora-playbook.ymlmust be updated tobranches: mainas indicated in the PR checklist before this PR can be merged.🤖 Prompt for AI Agents