docs(mirromaker): added valid options for config #1722
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richard-joerger-aiven
added
the
no changelog
|
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:
(it should all be lowercase) Please feel free to reach out if there are any questions! |
Serpentiel
suggested changes
May 13, 2024
There was a problem hiding this comment.
-
Comment above.
-
Docs linter fails because the docs change is out of sync with the schema of the resource. Please mirror the proposed change to
internal/sdkprovider/service/kafka/mirrormaker_replication_flow.go.- You can run
make docsto automatically generate docs from the schema, but this is optional and you can instead keep the file that you've manually edited already.
- You can run
richard-joerger-aiven
changed the title
richard-joerger-aiven
force-pushed
the
rjoerger-kafka-mm-docs-correction
branch
from
db20610 to
de79ec9
Compare
Serpentiel
changed the title
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
Adding in the missing docs line so its the same across the resouce and data source for mirrormaker_replication_flow
git diff on push shows extra spaces. Have to remove them as `make docs` isn't working.
Serpentiel
force-pushed
the
rjoerger-kafka-mm-docs-correction
branch
from
af0d33d to
5052bbc
Compare
Serpentiel
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.