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

Correct comment in sample.env for KAFKA_TYPE env var #82

Merged
merged 1 commit into from
May 31, 2024

Conversation

dmccoystephenson
Copy link
Member

PR Details

Description

Problem

The comment associated with the KAFKA_TYPE environment variable is incorrect and misleading at this time.

Solution

The comment associated with the KAFKA_TYPE environment variable has been corrected.

Related Issue

No related GitHub issue.

Motivation and Context

Comments associated with environment variables should be accurate and not misleading.

How Has This Been Tested?

Change to documentation, no testing necessary.

Types of changes

  • Defect fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that cause existing functionality to change)
  • Documentation change

Checklist:

  • I have added any new packages to the sonar-scanner.properties file
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
    ODE Contributing Guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Collaborator

@drewjj drewjj left a comment

Choose a reason for hiding this comment

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

Nice, this definitely makes this clearer.

Copy link

@mwodahl mwodahl left a comment

Choose a reason for hiding this comment

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

Looks great!

Copy link

@payneBrandon payneBrandon left a comment

Choose a reason for hiding this comment

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

lgtm!

@payneBrandon payneBrandon merged commit c0f8153 into dev May 31, 2024
4 checks passed
@payneBrandon payneBrandon deleted the docs/correct-kafka-type-comment-in-sample-env branch May 31, 2024 22:21
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