chore: add config docs generation #601
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
jeqo
force-pushed
the
jeqo/refactor-cache-config
branch
from
b1576a8
to
b6d58ca
Compare
jeqo
force-pushed
the
jeqo/refactor-cache-config
branch
from
b6d58ca
to
881af51
Compare
jeqo
force-pushed
the
jeqo/docs
branch
5 times, most recently
from
4c360de
to
1128908
Compare
Needed to print the right valid values on docs
Needed for documentation to be generated centrally.
Add module to generate config documentation
biggusdonzus
approved these changes
Oct 4, 2024
There was a problem hiding this comment.
@jeqo my autism tingles because some constants are public and other private in core/src/main/java/io/aiven/kafka/tieredstorage/config/RemoteStorageManagerConfig.java , but i understand why you did it and i don't have a better idea so it's good enough.
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.
Improves config descriptions and adds doc module.
See commits for more details.
Adding a git check to ensure docs are updated when source changes. Validation: https://github.com/Aiven-Open/tiered-storage-for-apache-kafka/actions/runs/11164414848/job/31033700687?pr=601