aiven / terraform-provider-aiven

Aiven Terraform Provider
https://registry.terraform.io/providers/aiven/aiven/latest/docs
MIT License
122 stars 68 forks source link

docs(mirromaker): added valid options for config #1722

Closed richard-joerger-aiven closed 1 month ago

richard-joerger-aiven commented 2 months ago

offset_syncs_topic_location takes a string of "source" or "target" but the docs did not reflect that. The config also lacks a default and that was not captured. This adds the valid options and the lack of a default

About this change—what it does

offset_syncs_topic_location takes a string of "source" or "target" but the docs did not reflect that. The config also lacks a default and that was not captured. This adds the valid options and the lack of a default

Why this way

Based on the other configs, this is the approach that is used to document.

Serpentiel commented 1 month ago

Hey, @richard-joerger-aiven! 👋

Thanks for your contribution. Could you please update your commit's message and PR title to align with Conventional Commits spec?

Here's an example of how it should be like in order to be complaint with the spec:

docs(mirrormaker): added valid options for config

(it should all be lowercase)

Please feel free to reach out if there are any questions!