Quarkus-based Polaris service runtime #469
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adutra
force-pushed
the
polaris-quarkus-replacement
branch
from
f714c40 to
dcf8ccd
Compare
adutra
force-pushed
the
polaris-quarkus-replacement
branch
4 times, most recently
from
2f18194 to
adfbbc2
Compare
adutra
force-pushed
the
polaris-quarkus-replacement
branch
7 times, most recently
from
4ac2974 to
5cc6fec
Compare
adutra
changed the title
adutra
force-pushed
the
polaris-quarkus-replacement
branch
13 times, most recently
from
fe8b9dc to
9fd4ce3
Compare
11 tasks
adutra
force-pushed
the
polaris-quarkus-replacement
branch
from
c6bfb41 to
6915daf
Compare
adutra
force-pushed
the
polaris-quarkus-replacement
branch
8 times, most recently
from
3da4643 to
a36d0ac
Compare
This was referenced Jan 8, 2025
adutra
force-pushed
the
polaris-quarkus-replacement
branch
2 times, most recently
from
2f76392 to
1ca28db
Compare
adutra
force-pushed
the
polaris-quarkus-replacement
branch
from
1ca28db to
362efda
Compare
snazy
approved these changes
Jan 9, 2025
adutra
force-pushed
the
polaris-quarkus-replacement
branch
from
362efda to
81f70bb
Compare
snazy
approved these changes
Jan 10, 2025
snazy
added a commit
to snazy/polaris
that referenced
this pull request
Jan 10, 2025
Having documentation about the configuration that is both "up-to-date" and "in-sync with the source code" with the actual code is good practice. The functionality added in this change allows generating markdown docs from smallrye-config based configuration types, starting at and grouped by types that are annotated with `@ConfigMapping`. The javadoc of the config interfaces and properties is emitted as markdown. On top there is functionality to generate reference docs for "static" types (currently unused in Polaris). The code is nearly a 1:1 port of the same functionality in Nessie. This change will become useful with/after apache#469. Gradle projects added in this change are: * `polaris-config-doc-annotations` adds an annotation used when generating docs to influence the generation of the configuration reference docs. * `polaris-config-doc-generator` is the reference doc generator implementation, as a "standalone" tool that uses javadoc _infrastructure_. See `ReferenceConfigDocsGenerator` why it needs to be a separate tool than "just" a doclet (class loader isolation issues). * `polaris-site-reference-docs` actually generates the markdown files from referenced Gradle projects. Currently there are no projects referenced, so generation yields nothing. The generated docs are not yet integrated into the website, which will happen in a follow-up PR.
1 task
|
I'm in favor of merging this PR now. There are already a bunch of follow-up PRs that depend on this one and it's hard to keep up. |
adutra
force-pushed
the
polaris-quarkus-replacement
branch
from
81f70bb to
fba76ab
Compare
snazy
approved these changes
Jan 10, 2025
dimas-b
approved these changes
Jan 10, 2025
jbonofre
approved these changes
Jan 10, 2025
|
@collado-mike @dennishuo @dennishuo @flyrain @eric-maynard @adutra @dimas-b @snazy I propose to click the merge button on Tuesday (Jan 14). If you have any objection, please add a comment/request change in the PR. |
adutra
force-pushed
the
polaris-quarkus-replacement
branch
from
fba76ab to
31be245
Compare
adutra
force-pushed
the
polaris-quarkus-replacement
branch
from
31be245 to
779d0bd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #392.
Read the
README_quarkus.mdfile for more details on what changes, how, and what remains to be done.