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

Updated JAX-WS user guide. #380

Merged
merged 7 commits into from
Aug 10, 2020
Merged

Updated JAX-WS user guide. #380

merged 7 commits into from
Aug 10, 2020

Conversation

Tomas-Kraus
Copy link
Contributor

Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
Copy link
Contributor

@edbratt edbratt left a comment

Choose a reason for hiding this comment

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

Thank you for making these changes. I checked out your branch, built it and reviewed the content. Here are my comments, please review and check-off when you are satisfied with your results:

  • attributes.conf: please change {TechnologyRI} to Eclipse GlassFish 6.0; Also, change {TechnolobyRIURL} property to: https://projects.eclipse.org/projects/ee4j.glassfish
  • same file: I believe that the TCK download file name will not include the date string. Please change {TCKPackageName} to jakarta-xml-ws-tck-3.0.0.zip
  • same file: please set SpecificationInquiryList to mailto:jaxws-dev@eclipse.org[jaxws-dev@eclipse.org]
  • install-server.inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Installation chapter (install.adoc))
  • config,inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Setup and Configuration chapter (config.adoc)
  • using.inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Executing Tests chapter (using.adoc), section 5.6 and higher)
  • rebuild.inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Appendix B (rebuild.adoc))

@Tomas-Kraus
Copy link
Contributor Author

Tomas-Kraus commented Jul 31, 2020

Thank you for making these changes. I checked out your branch, built it and reviewed the content. Here are my comments, please review and check-off when you are satisfied with your results:

* [X]  attributes.conf: please change {TechnologyRI} to Eclipse GlassFish 6.0; Also, change {TechnolobyRIURL} property to: https://projects.eclipse.org/projects/ee4j.glassfish

* [X]  same file: I believe that the TCK download file name will not include the date string. Please change {TCKPackageName} to jakarta-xml-ws-tck-3.0.0.zip

I don't know. Local build produces package with date. But I changed it.

* [X]  same file: please set SpecificationInquiryList to mailto:[jaxws-dev@eclipse.org](mailto:jaxws-dev@eclipse.org)[[jaxws-dev@eclipse.org](mailto:jaxws-dev@eclipse.org)]

* [X]  install-server.inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Installation chapter (install.adoc))

* [X]  config,inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Setup and Configuration chapter (config.adoc)

* [X]  using.inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Executing Tests chapter (using.adoc), section 5.6 and higher)

* [X]  rebuild.inc: please review and update this file as it seems to still contain legacy package names and terminology. (rendered in Appendix B (rebuild.adoc))

Removed DRAFT from POM.

Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
@Tomas-Kraus
Copy link
Contributor Author

@edbratt I went trough the document again and fixed what I recognized as wrong. Hope it's OK now.

Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
Copy link
Contributor

@edbratt edbratt left a comment

Choose a reason for hiding this comment

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

Looks like most of the previous changes were implemented. Regretfully, I have a few more suggestions:

  • config.inc line 15: change Reference Implementation to Compatible Implementation
    config,inc line 286 - should not be changed. Java SE 8 is correct.
    config.inc line 320 - add more '^' characters for formatting engine
    config.inc line 324 to bottom - Change Reference Implementation to Compatible Implementation (note, line 518 may require some rewording, perhaps "Configure the provided JAX-WS Compatible Implementation as your Compatible Implementation environment")
  • using.inc line 10 the number of tilde (~) characters need to exactly match the number of characters (including spaces) in the previous line. (The change from RI to Compatible Implementation broke the formatting); Same comment on line 48.
  • using.inc: general -- throughout, change Reference Implementation to Compatible Implementation (watch for format issues)
  • install-server.inc, line 13 - change first word on the line from Reference to Compatible
    install-server.inc, line 15 - change last word on the line from Reference to Compatible
    install-server.inc, line 20 - change last word on the line from Reference to Compatible
    install-server.inc, line 49 - change last word on the line from Reference to Compatible
  • rebuild.inc, general: change Reference Implementation to Compatible Implementation
  • faq.adoc line 58 -- might as well update line reference implementation -> compatible implementation.
    You might consider using the generated pdf and word-search to check for missed changes.

user_guides/jaxws/src/main/jbake/content/config.inc Outdated Show resolved Hide resolved
Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
@Tomas-Kraus Tomas-Kraus requested a review from edbratt August 10, 2020 13:04
Copy link
Contributor

@edbratt edbratt left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you Tomas.

@edbratt edbratt merged commit 48dec0a into jakartaee:master Aug 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants