-
Notifications
You must be signed in to change notification settings - Fork 580
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
[New Docs PR] - Helidon MP OpenAPI #4209 #4421
[New Docs PR] - Helidon MP OpenAPI #4209 #4421
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
General notes:
- I had created PR Fix config doc annotations for OpenAPI builder #4419 with
pom.xml
and.java
and generateddocs/shared/config/*.adoc
file changes in it earlier. I've continued to fine-tune those changes. Following up on Tomas's comment in our recent meeting, let's use those changes and reserve this PR for the hand-written.adoc
content. (We could try to merge that PR's changes into this one but there's no real need to do so and it would just create unneeded work for someone.) - I think there will be considerable shared content between the updated SE and MP OpenAPI
.adoc
pages. It probably makes sense to continue with the changes todocs/mp/openapi/01_openapi.adoc
as drafted (and commented on) here with the understanding that we will want to refactor the common content out into a separate file that this.adoc
and the SE one will both include, rather than duplicating the content in two places.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent progress. A few minor edits left.
9ec139a
to
8d1d20a
Compare
8d1d20a
to
788910f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So close! See especially the comment about the links to the MP OpenAPI doc.
And since you'll be updating the file, there's one other much more minor note.
Resolves #4209