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

Consider Optional Config Group and Sets in config doc generation #5703

Closed
machi1990 opened this issue Nov 22, 2019 · 0 comments · Fixed by #5719
Closed

Consider Optional Config Group and Sets in config doc generation #5703

machi1990 opened this issue Nov 22, 2019 · 0 comments · Fixed by #5719
Assignees
@machi1990
Labels
area/config area/documentation kind/enhancement New feature or request
Milestone
1.1.0.CR1

Comments

@machi1990
Copy link
Member

#5387 comes with so many goodness like added support for Optional config group and Sets. The config doc generator must also improve in the same sense and must recognise these two constructs.

Quick ideas.

  • mark all config items inside a optional group as as optional
  • do not display type information for Set but list of or set of ?

/cc @dmlloyd as discussed here #5387 (comment)
@machi1990 machi1990 added kind/bug Something isn't working kind/enhancement New feature or request area/documentation area/config and removed kind/bug Something isn't working labels Nov 22, 2019
@machi1990 machi1990 self-assigned this Nov 22, 2019
@machi1990 machi1990 mentioned this issue Nov 23, 2019
Closed
machi1990 added a commit to machi1990/quarkus that referenced this issue Nov 23, 2019
@machi1990
strip Runtime suffix when dereving config root name in doc generation
8d52d4e 
handle optional config group in doc generation

Fixes quarkusio#5703

Follows up quarkusio#5387
@machi1990 machi1990 mentioned this issue Nov 23, 2019
Merged
machi1990 added a commit to machi1990/quarkus that referenced this issue Nov 24, 2019
@machi1990
strip Runtime suffix when dereving config root name in doc generation
3568e65 
handle optional config group in doc generation

Fixes quarkusio#5703

Follows up quarkusio#5387
machi1990 added a commit to machi1990/quarkus that referenced this issue Nov 24, 2019
@machi1990
strip Runtime suffix when dereving config root name in doc generation
fb8bb1d 
handle optional config group in doc generation

Fixes quarkusio#5703

Follows up quarkusio#5387
dmlloyd added a commit that referenced this issue Dec 2, 2019
@dmlloyd
Merge pull request #5719 from machi1990/enhancement/5144
cf888d0 
Config documentation generation fixes for #5144 and #5703
@gsmet gsmet added this to the 1.1.0 milestone Dec 8, 2019
mmusgrov pushed a commit to mmusgrov/quarkus that referenced this issue Dec 13, 2019
@machi1990 @mmusgrov
strip Runtime suffix when dereving config root name in doc generation
dbf81e3 
handle optional config group in doc generation

Fixes quarkusio#5703

Follows up quarkusio#5387
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@machi1990 machi1990

Labels
area/config area/documentation kind/enhancement New feature or request
Projects
None yet
Milestone
1.1.0.CR1
Development

Successfully merging a pull request may close this issue.

Config documentation generation fixes for #5144 and #5703 machi1990/quarkus
2 participants
@gsmet @machi1990