Stephane Epardaud
b9b35623be
Changes for config cogs tweak
...
Also renamed the generated all-config due to jekyll giving it precedence of the the guide itself
2020-02-21 14:43:52 +01:00
Georgios Andrianakis
4a680de093
Add first version of bootstrap config support
2020-02-10 18:16:24 +02:00
Guillaume Smet
9929d87d10
Fix the title of generated config doc for uncategorized properties
2019-12-12 00:31:55 +01:00
Georgios Andrianakis
7c1e1bde59
Try to fix doc issue with anonymous config root
2019-12-07 19:40:55 +01:00
Manyanda Chitimbo
fb8bb1d63f
strip Runtime suffix when dereving config root name in doc generation
...
handle optional config group in doc generation
Fixes #5703
Follows up #5387
2019-11-24 22:03:20 +01:00
Manyanda Chitimbo
3deedec60e
generate a documentation file for each config root and general config items (non config group
...
Fixes #5144
Follows up #5044
2019-11-24 15:08:55 +01:00
Manyanda Chitimbo
384c3dceed
fix: doc generator so that config documentation website generator works
2019-11-22 12:48:03 -06:00
David M. Lloyd
9dd3919464
Introduce new configuration framework and update SmallRye Config version
...
Fixes #4123 , Fixes #4119 , Fixes #4172 , Fixes (part of) #2292
Fixes #734 , Fixes #4512 , Fixes #3498 , Fixes #3937
Fixes #2816 , Fixes #4077 , Fixes #3516 , Fixes #2760
Fixes #1989 , Fixes #3030 , Fixes #3637 , Fixes #1887
Groundwork for #2489 , Fixes #5116 , Fixes #5192 , Fixes #3888
Fixes #3089 , Fixes #390 , Fixes #891 , Fixes #5484
Fixes #5454
2019-11-22 12:48:03 -06:00
Manyanda Chitimbo
8fa13af584
fix: use unique key name when generating config section anchor
...
The issue was reported here - https://github.com/quarkusio/quarkus/pull/4529#issuecomment-551883480
2019-11-10 23:31:09 +01:00
Guillaume Smet
1c6d3aa104
Merge pull request #5168 from rsvoboda/String.format.new.line
...
Use %n for new line in case of String.format
2019-11-05 21:46:16 +01:00
Rostislav Svoboda
80dc8211de
Use %n for new line in case of String.format
2019-11-05 08:45:27 +01:00
Guillaume Smet
ff84cc2ab3
Merge pull request #4715 from machi1990/fix/hide-map-key-for-pass-through-config
...
fix(docs): propose a mapKey for generated config docs of a Map config item only for config group
2019-11-04 17:23:33 +01:00
Manyanda Chitimbo
a33cb74e26
docs: display types information for pass through Map config item
2019-11-04 14:20:01 +01:00
Manyanda Chitimbo
f40b846944
refactor: remove comments
2019-11-04 14:20:01 +01:00
Manyanda Chitimbo
47187603f5
fix(docs): propose a mapKey for generated config docs of a Map config item only for config group
...
Fixes #4700
2019-11-04 14:20:01 +01:00
Yoann Rodière
022d54b6e4
Fix documentation: PT is *prepended* to duration values, not appended
...
See the relevant code in DurationConverter:
if (START_WITH_DIGITS.asPredicate().test(value)) {
return Duration.parse(PERIOD_OF_TIME + value);
}
2019-11-04 13:44:32 +01:00
Manyanda Chitimbo
5ab8513ae8
docs: avoid generating partial documentation
2019-11-01 20:22:03 +01:00
Manyanda Chitimbo
0849187379
docs: generate a specific documentation file for each config group
...
The file can be included via \include::{generated-dir}/config/quarkus-your-extension-dashed-config-group-simple-name.adoc[opts=optional, leveloffset=+1]
2019-11-01 20:20:56 +01:00
Stuart Douglas
549fb6393c
Merge pull request #4940 from FroMage/all-config-docs-anchors
...
Added anchors to configuration keys and sections
2019-10-29 22:27:41 +11:00
Stephane Epardaud
d785e9cb3e
Fixed test due to javadoc parser changes
2019-10-29 11:28:45 +01:00
Stephane Epardaud
a354be5633
JavaDocParser: support code tags and properly generate links
2019-10-29 11:28:45 +01:00
Stephane Epardaud
31bf87b033
Use prefixes even for individual config pages
...
Using the file name as prefix since we don't have the artifactId
2019-10-29 11:27:52 +01:00
Stephane Epardaud
5ac9f71e50
Added anchors to configuration keys and sections
2019-10-29 11:27:52 +01:00
Manyanda Chitimbo
5e1054f533
docs: merge config doc sections if they have same title
...
Fixes #4699
2019-10-24 00:16:26 +02:00
Stephane Epardaud
01cc063d4c
Make sure stand-alone config pages that don't have a section end up with a column header
2019-10-22 17:36:30 +02:00
Stephane Epardaud
be1475b6f2
Added the column labels to the extension header row
2019-10-22 17:07:03 +02:00
Stephane Epardaud
e1cd7f8768
Add column headers to every section
2019-10-22 17:07:03 +02:00
Sanne Grinovero
28a32b3a59
Merge pull request #4623 from machi1990/docs/remove-test-extension-from-all-generate-config-docs
...
avoid generating config documentation for the test-extension
2019-10-17 17:55:19 +01:00
Stephane Epardaud
f4b8b8722e
Better visuals for required properties
2019-10-17 10:39:50 +02:00
Manyanda Chitimbo
249c7141e1
docs: avoid generating config documentation for the test-extension
2019-10-16 21:36:05 +02:00
Stephane Epardaud
c573cf94a7
Document lists/required values
2019-10-16 16:34:57 +02:00
Stephane Epardaud
c2b3cb4f60
Default to logging/guessing the extension name if missing
2019-10-16 12:05:28 +02:00
Stephane Epardaud
209b49416c
Removed obsolete function
2019-10-15 18:06:17 +02:00
Stephane Epardaud
d767cd2931
Generate all config docs based on new info stored in devtools/core-extensions-json/target/extensions.json
2019-10-15 18:01:58 +02:00
Stephane Epardaud
e5344b4125
Added make-do config name to all-config page
2019-10-11 18:08:56 +02:00
Stephane Epardaud
0e21692f0e
First draft of page displaying all the configuration properties
2019-10-09 18:37:51 +02:00
Stephane Epardaud
6f22b14c68
Implement a searchable/expandable config table
...
Also remove the detailed view as it's not useful anymore.
2019-10-09 18:37:40 +02:00
Manyanda Chitimbo
d0257fdc93
docs: add support of config doc sections in generated docs
...
docs: add a possibility to specify a key of a map config item through @ConfigDocMapKey
Fixes #4045
2019-10-09 11:35:53 +02:00
Guillaume Smet
5fb597bcb6
Change InetSocketAddress to host:port in doc generation
2019-09-30 12:58:47 +02:00
Guillaume Smet
423044b4a9
Remove an outdated Jackson version
...
This version has a CVE: we should use the one from the bom.
2019-09-24 15:09:26 +02:00
Guillaume Smet
3d73c24508
Merge pull request #3940 from gastaldi/remove_junit4
...
Remove quarkus-junit4 and junit4 in the BOM
2019-09-17 22:49:52 +02:00
Guillaume Smet
d60a5d6dca
Add a style to the config table
...
I wasn't able to have the colgroup widths generated by Asciidoctor to
work on the website so I had to manually style them.
Also make the column size consistent with what I chose for the website.
2019-09-11 17:07:51 +02:00
Guillaume Smet
3cdb9da332
Use the cogs icon instead of gears as website uses an old Font Awesome
2019-09-11 17:07:51 +02:00
George Gastaldi
89213fee60
chore: migrate quarkus-extension-processor tests to JUnit 5
2019-09-10 20:29:29 +00:00
Guillaume Smet
9b50bb714c
Move the generated documentation to a global target/ directory
...
We can't have the generated files in docs/target as it is cleaned prior
to generating the documentation when doing a mvn clean install.
Fixes #3909
2019-09-10 15:47:31 +02:00
Guillaume Smet
b95f797d7e
Prepend lines with a star as it's what is expected by the parser
2019-09-10 15:47:31 +02:00
Guillaume Smet
ce6a769cc9
Remove leading space in the extracted Javadoc
...
The space just after the star is kept by the javax.lang.model API so
let's remove it.
2019-09-10 15:47:31 +02:00
Guillaume Smet
44d9e1a1b0
Add a light separator after each configuration entry in the details
...
Note that we will have to tweak the website CSS to keep it light.
2019-09-10 15:47:31 +02:00
Guillaume Smet
196f340c41
Unify EOL on all platforms when returning the original Asciidoc
...
The Javadoc parser we use uses platform specific EOL characters.
This should fix the Windows CI failure.
2019-09-10 15:47:31 +02:00
Guillaume Smet
8d8d20290d
Restructure the parser to allow passing optional Asciidoc comment
...
Asciidoc comment are passthrough but we needed to restructure the parser
to enable proper parsing.
2019-09-10 15:47:31 +02:00