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

4.x: Update generated config reference #8852

Merged
merged 3 commits into from
Jun 7, 2024
Merged

4.x: Update generated config reference #8852

merged 3 commits into from
Jun 7, 2024

Conversation

tomas-langer
Copy link
Member

@tomas-langer tomas-langer commented Jun 6, 2024 •
edited
Loading

Related to #8793

Config metatadata:

  • Handle enum types better for default value
  • Javadoc processing in a separate class to make it more readable

Config reference docs:

  • Fixed tables in option descriptions
  • No longer displaying @return, @see in option descriptions

Also includes updates of documentation generated from the updated metadata files.

@tomas-langer
Config metatadata:
8a0c4e2 
Handle enum types better for default value
Javadoc processing in a separate class to make it more readable
Config reference docs:
Fixed tables in option descriptions
No longer displaying `@return`, `@see` in option descriptions
@tomas-langer tomas-langer added the 4.x Version 4.x label Jun 6, 2024
@tomas-langer tomas-langer self-assigned this Jun 6, 2024
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jun 6, 2024
@tomas-langer tomas-langer mentioned this pull request Jun 6, 2024
Closed
tjquinno
tjquinno reviewed Jun 6, 2024
View reviewed changes
Copy link
Member

@tjquinno tjquinno left a comment

Choose a reason for hiding this comment

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

The changes LGTM as far as I know, but I do not see how these changes actually address the issue the PR claims to resolve. And there is no test to verify the fix for that issue.

tjquinno
tjquinno approved these changes Jun 6, 2024
View reviewed changes
Copy link
Member

@tjquinno tjquinno left a comment

Choose a reason for hiding this comment

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

Ah, OK. I guess that you hand-edited the generated AccessLogConfig .adoc file for the embedded table; that's why there's nothing in the code and no test for that. Got it.

@tomas-langer
Copy link
Member Author

Ah, OK. I guess that you hand-edited the generated AccessLogConfig .adoc file for the embedded table; that's why there's nothing in the code and no test for that. Got it.

This PR changes a smaller thing in the annotation processor.
The tables (and in general HTML) in the description is not processed in Helidon - it is a standalone project, that contains translation from JSON metadata to adoc files.
The handling of tables is part of that project.
So I cannot even add a test here, as there is nothing to test.

@tomas-langer tomas-langer merged commit 97bcf73 into helidon-io:main Jun 7, 2024
12 checks passed
@tomas-langer tomas-langer deleted the 8793-config-reference branch June 7, 2024 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tjquinno tjquinno tjquinno approved these changes

@romain-grecourt romain-grecourt romain-grecourt approved these changes

Assignees

@tomas-langer tomas-langer

Labels
4.x Version 4.x OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tomas-langer @romain-grecourt @tjquinno