Refactor dynamicconfig comments for documentation #4129
Merged
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.
What changed?
Refactor dynamicconfig comments
Why?
To introduce a better way to manage/maintain the documentation of dynamic configuration for the community
Currently it requires developer to go to cadence-docs to update the configuration.
This is tedious and inconvenient for our developers. Moreover, there is no easy way to know what configurations is available in which release versions.
A better way is just update in the comments, and go-docs will automatically update the document with the right release version. See example: https://pkg.go.dev/github.com/uber/cadence@v0.19.1/common/service/dynamicconfig#Key
How did you test it?
Existing
Potential risks
No. only comment change.
Release notes
Documentation Changes
Will update cadence-docs to use go-docs after this is released.
uber/Cadence-Docs#33