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.

Sign up for GitHub

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

Jump to bottom

Missing adoc documentation for ConfigSource configuration #710

Open
mate-biro opened this issue Oct 10, 2024 · 0 comments · May be fixed by #718
Open

Missing adoc documentation for ConfigSource configuration #710

mate-biro opened this issue Oct 10, 2024 · 0 comments · May be fixed by #718
Assignees
@gyengus
Labels
documentation Improvements or additions to documentation

Comments

@mate-biro
Copy link
Contributor

mate-biro commented Oct 10, 2024 •
edited
Loading

It is possible to disable a ConfigSource with configuration, e.g.: hu.icellmobilsoft.coffee.module.etcd.producer.CachedEtcdConfigSource.enabled: false

This information is missing from the adoc documentation. It can be only found in javadoc defined in the following class: hu.icellmobilsoft.coffee.cdi.configsource.ConfigurableConfigSource

There are two ways to set this configuration based on the return value of the following methods:

  • ConfigurableConfigSource.getClassEnableKey()
  • ConfigurableConfigSource.getConfigSourceNameKey()

It would be nice to have these thoroughly documented.
@mate-biro mate-biro added the documentation Improvements or additions to documentation label Oct 10, 2024
@gyengus gyengus self-assigned this Nov 27, 2024
gyengus added a commit that referenced this issue Nov 28, 2024
@gyengus
#710 Add more documentation to CachedEtcdConfigSource
580f424
@mate-biro mate-biro linked a pull request Dec 2, 2024 that will close this issue
#710 Add more documentation to CachedEtcdConfigSource #718
Open
gyengus added a commit that referenced this issue Dec 5, 2024
@gyengus
#710 Add more documentation and translate it to hungarian
1293d6d
gyengus added a commit that referenced this issue Dec 23, 2024
@gyengus
#710 Change documentation
a2d9727
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gyengus gyengus

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#710 Add more documentation to CachedEtcdConfigSource i-Cell-Mobilsoft-Open-Source/coffee
2 participants
@gyengus @mate-biro