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

docs(config): extend configuration example OM-521 #843

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

Conversation

GAlexIHU
Copy link
Contributor

@GAlexIHU GAlexIHU commented May 3, 2024

Overview

Updates config.example.yaml to include all configurable properties alongside their descriptions. Onwards, care should be taken when configuration changes, to validate the example is always up to date with reality.

Fixes #(issue)
OM-521

Notes for reviewer

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@GAlexIHU GAlexIHU added the kind/documentation Improvements or additions to documentation label May 3, 2024
@tothandras tothandras changed the title docs(config): extend configuration example docs(config): extend configuration example OM-521 May 3, 2024
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
Co-authored-by: Márk Sági-Kazár <[email protected]>
Signed-off-by: Alex Goth <[email protected]>
# ## Kafka connection configuration
# kafka:
# broker: 127.0.0.1:29092
# eventstopictemplate: om_%s_events
Copy link
Contributor

Choose a reason for hiding this comment

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

There are other places for camelCasing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants