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.

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

Generate documentation file for config group #5044

Conversation

machi1990
Copy link
Member

@machi1990 machi1990 commented Oct 30, 2019

1st commit:
Make it possible to generate a file par config group.

2nd commit:
use the generated file for FormAuthConfig to avoid the usage of an inexistant file which was generating the following warning

asciidoctor: INFO: security-guide.adoc: line 69: optional include dropped because include file not found: target/asciidoc/generated/config/quarkus-http-auth-form.adoc 

3rd commit:
Resolves #5097

@gsmet gsmet added this to the 0.28.0 milestone Oct 30, 2019
@machi1990 machi1990 force-pushed the docs/remove-usage-of-inexistant-generated-doc-file branch from 5fee56b to 91a0fb2 Compare October 31, 2019 19:52
@machi1990 machi1990 changed the title docs: remove the use of an inexistant generated doc file generate documentation file for config group Oct 31, 2019
@machi1990 machi1990 requested a review from gsmet October 31, 2019 19:56
@machi1990
Copy link
Member Author

machi1990 commented Oct 31, 2019

@gsmet I have added a commit which enable the generation of config group as discussed above.

Screenshot 2019-10-31 at 20 50 47

@machi1990 machi1990 force-pushed the docs/remove-usage-of-inexistant-generated-doc-file branch 3 times, most recently from 8165bd6 to c6ec3fb Compare November 1, 2019 17:13
The file can be included via \include::{generated-dir}/config/quarkus-your-extension-dashed-config-group-simple-name.adoc[opts=optional, leveloffset=+1]
@machi1990 machi1990 force-pushed the docs/remove-usage-of-inexistant-generated-doc-file branch from c6ec3fb to 5ab8513 Compare November 1, 2019 19:32
Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the output and everything looks in order. We can tune it later if needed.

@gsmet gsmet merged commit c748664 into quarkusio:master Nov 3, 2019
@machi1990 machi1990 deleted the docs/remove-usage-of-inexistant-generated-doc-file branch November 3, 2019 20:02
@gsmet gsmet changed the title generate documentation file for config group Generate documentation file for config group Nov 3, 2019
machi1990 added a commit to machi1990/quarkus that referenced this pull request Nov 23, 2019
machi1990 added a commit to machi1990/quarkus that referenced this pull request Nov 24, 2019
mmusgrov pushed a commit to mmusgrov/quarkus that referenced this pull request Dec 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated docs are sometimes overridden when running full build
3 participants