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

[New Docs PR] - Helidon MP OpenAPI #4209 #4421

Merged

Conversation

dalexandrov
Copy link
Contributor

Resolves #4209

@dalexandrov dalexandrov added docs open-api 3.x Issues for 3.x version branch labels Jun 22, 2022
@dalexandrov dalexandrov self-assigned this Jun 22, 2022
@dalexandrov dalexandrov requested a review from tjquinno June 22, 2022 13:24
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.

General notes:

  1. I had created PR Fix config doc annotations for OpenAPI builder #4419 with pom.xml and .java and generated docs/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.)
  2. 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 to docs/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.

docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
@dalexandrov
Copy link
Contributor Author

  1. I hope did it right. Would you please check.
  2. I think, a good idea will be to first finish this doc, to have it as a reference, and then, as we edit the SE doc, to extract the common parts and edit both of them. I hope you like this idea :)

@dalexandrov dalexandrov requested a review from tjquinno June 27, 2022 09:30
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.

Excellent progress. A few minor edits left.

@dalexandrov dalexandrov requested a review from tjquinno June 29, 2022 14:39
@dalexandrov dalexandrov marked this pull request as ready for review June 29, 2022 14:39
@dalexandrov dalexandrov force-pushed the 4209_Doc_Helidon_MP_OpenAPI branch from 9ec139a to 8d1d20a Compare June 30, 2022 08:13
@dalexandrov dalexandrov force-pushed the 4209_Doc_Helidon_MP_OpenAPI branch from 8d1d20a to 788910f Compare June 30, 2022 08:31
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.

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.

docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
docs/mp/openapi/01_openapi.adoc Outdated Show resolved Hide resolved
@romain-grecourt romain-grecourt merged commit 4adaf5c into helidon-io:master Jun 30, 2022
@dalexandrov dalexandrov deleted the 4209_Doc_Helidon_MP_OpenAPI branch July 11, 2022 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.x Issues for 3.x version branch docs open-api
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc:] Helidon MP OpenAPI
3 participants