Skip to content

Fix heading for AWS Glue entry#380

Merged
kbatuigas merged 1 commit intomainfrom
kbatuigas-patch-1
Aug 6, 2025
Merged

Fix heading for AWS Glue entry#380
kbatuigas merged 1 commit intomainfrom
kbatuigas-patch-1

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented Aug 6, 2025

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@kbatuigas kbatuigas requested a review from a team as a code owner August 6, 2025 14:56
@netlify
Copy link
Copy Markdown

netlify bot commented Aug 6, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 56ab326
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68936d12fb435d0007bc93f4
😎 Deploy Preview https://deploy-preview-380--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 6, 2025

📝 Walkthrough

Walkthrough

This change updates the heading level for the "Iceberg topics with AWS Glue" section in the Redpanda Cloud "What's New" documentation for August 2025. The section heading is modified from a level 2 heading (==) to a level 3 heading (===). No other content or documentation structure is altered.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • Iceberg beta - Azure #293: Modifies the same documentation file and also relates to Iceberg topics, but focuses on adding a new subsection for Azure beta rather than changing heading levels.

Suggested reviewers

  • simon0191

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca2f913 and 56ab326.

📒 Files selected for processing (1)
  • modules/get-started/pages/whats-new-cloud.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
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#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#261
File: modules/get-started/pages/cluster-types/byoc/aws/create-byoc-cluster-aws.adoc:46-50
Timestamp: 2025-04-18T19:43:32.991Z
Learning: In the Redpanda documentation using AsciiDoc format, explanatory text that provides additional information about a step should not be formatted as a separate numbered step. Instead, it should appear as regular text with bullets (using ** syntax) for any sub-points.
📚 Learning: the timeline for major upgrade notifications (180 days in advance) was intentionally removed from th...
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.

Applied to files:

  • modules/get-started/pages/whats-new-cloud.adoc
📚 Learning: the notification timeline for redpanda cloud deprecations has been deliberately removed from the doc...
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.

Applied to files:

  • modules/get-started/pages/whats-new-cloud.adoc
📚 Learning: in the redpanda cloud documentation system using asciidoctor, glossary cross-references with spaces ...
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#350
File: modules/get-started/pages/cloud-overview.adoc:55-56
Timestamp: 2025-07-16T21:11:59.964Z
Learning: In the Redpanda Cloud documentation system using Asciidoctor, glossary cross-references with spaces in the ID (like `glossterm:data plane[]`) work correctly and do not need to be changed to hyphenated forms. The existing syntax is functional and should not be modified.

Applied to files:

  • modules/get-started/pages/whats-new-cloud.adoc
🔇 Additional comments (1)
modules/get-started/pages/whats-new-cloud.adoc (1)

12-12: Heading level now consistent with surrounding structure

Changing the “Iceberg topics with AWS Glue” heading from == to === correctly nests it under the August 2025 month section, matching the pattern used for all other month subsections. No further action needed.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch kbatuigas-patch-1

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@kbatuigas kbatuigas merged commit ae2d15f into main Aug 6, 2025
4 of 5 checks passed
@kbatuigas kbatuigas deleted the kbatuigas-patch-1 branch August 6, 2025 15:01
micheleRP added a commit that referenced this pull request Aug 7, 2025
* DOC-1435 Add gcloud commands for creating firewall rules for PSC consumer

* fix API docs similarly

* Add Glue doc to Cloud (#363)

* Add Glue pages to Cloud

* Sync with docs main

* Use docs branch with updated Cloud-specific guidance

* Apply suggestion from PM review

* Add What's New entry

* Auth configs still need to be allowlisted for 25.1 in Cloud

* Update local-antora-playbook.yml

* Update @redpanda-data/docs-extensions-and-macros (#378)

* docs: fix property alias (#379)

* Fix heading for AWS Glue entry (#380)

* minor edits

* Paul's review feedback

* copilot suggestions for consistency

* coderabbit suggestions

* move step into BYOVPC section

* DOC-1435 Add gcloud commands for creating firewall rules for PSC consumer

* fix API docs similarly

* minor edits

* Paul's review feedback

* copilot suggestions for consistency

* coderabbit suggestions

* move step into BYOVPC section

* fixes from coderabbit

* minor edit

* incorporate doc review suggestions

---------

Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Co-authored-by: vbotbuildovich <62446873+vbotbuildovich@users.noreply.github.com>
Co-authored-by: Paulo Borges <paulohtb6@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants