Skip to content
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

INC-675 Add warning not to modify properties managed by Redpanda programs #979

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

asimms41
Copy link
Contributor

@asimms41 asimms41 commented Feb 5, 2025

Description

Resolves docs issue: INC-675
Review deadline: 24th March

See also related cloud docs PR: redpanda-data/cloud-docs#197

Page previews

Manage Topics (Self-Managed)
Manage Topics (Kubernetes)
Manage Topics (Cloud)
Compaction Settings
Topic Configuration Properties

Checks

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

@asimms41 asimms41 requested a review from a team as a code owner February 5, 2025 17:16
Copy link

netlify bot commented Feb 5, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 4908edb
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67e18991bb4cf40008679ea6
😎 Deploy Preview https://deploy-preview-979--redpanda-docs-preview.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 site configuration.

@asimms41 asimms41 marked this pull request as draft February 5, 2025 18:14
Copy link
Contributor

@tomasz-sadura tomasz-sadura left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

Copy link
Contributor

hyperlint-ai bot commented Mar 24, 2025

PR Change Summary

Added a warning regarding the modification of topic properties to prevent unexpected errors and failures.

  • Introduced a warning message for updating the default cleanup policy in topic properties.
  • Updated multiple documentation pages to include the new warning about modifying topic properties.
  • Ensured consistency across various sections regarding cleanup policy management.

Modified Files

  • modules/develop/pages/config-topics.adoc
  • modules/manage/pages/cluster-maintenance/compaction-settings.adoc
  • modules/manage/pages/kubernetes/k-manage-topics.adoc
  • modules/reference/pages/properties/topic-properties.adoc

Added Files

  • modules/develop/partials/topic-properties-warning.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@asimms41 asimms41 changed the title INC-675 Add warning for updating default cleanup policy INC-675 Add warning not to modify properties managed by Redpanda programs Mar 24, 2025
@asimms41 asimms41 requested a review from tomasz-sadura March 24, 2025 13:48
@asimms41 asimms41 marked this pull request as ready for review March 24, 2025 16:35
@asimms41 asimms41 requested a review from t-eckert March 24, 2025 16:36
@asimms41 asimms41 requested a review from Feediver1 March 25, 2025 16:29
Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

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.

4 participants