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

User guide for SAAJ updated. #376

Merged
merged 4 commits into from
Jul 31, 2020
Merged

User guide for SAAJ updated. #376

merged 4 commits into from
Jul 31, 2020

Conversation

Tomas-Kraus
Copy link
Contributor

Here is the guide: SAAJ-TCK-Users-Guide.pdf

Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>
@alwin-joseph alwin-joseph requested a review from edbratt July 23, 2020 18:05
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 -- please consider the following:

  • attributes.conf: Update the following properties: {TechnologyRI} to EclipseGlassFish 6.0; {TechnologyRIURL} to https://projects.eclipse.org/projects/ee4j.glassfish; {SpecificationInquiryList} to jaxws-dev@eclipse.org; {TCKPackageName} to jakarta-soap-tck-2.0.0.zip
  • req-software.inc - Change first example, "Java EE 8 RI" to "Eclipse GlassFish 6.0 Compatible Implementation"
  • install-server.inc - please update with current terminology (Java EE 8 RI -> Jakarta EE 9 Compatible Platform (some examples: Eclipse GlassFish 6); change RI to Compatible Implementation; Change software can be obtained from, to point to the Jakarta EE 9 Platform Specification page, or suggest the user can obtain a compatible implementation from Eclipse GlassFish 6).
  • debug-tips.inc - please delete the code header at the top of this file. Otherwise, this header is rendered in Chapt. 6, Debugging Test Problems (debug.adoc).
  • rebuild.inc - Please review this file and update language, component and package names (RI to Compatible Implementation, Etc.). This is rendered in Appendix B (rebuild.adoc).
  • install/saaj/docs/SAAJ2.0-ReleaseNotes.html: please update the release date in the page title.

@Tomas-Kraus
Copy link
Contributor Author

Tomas-Kraus commented Jul 31, 2020

Did local build. Bundle name is soap-tck-2.0.0_31-Jul-2020.zip. Removing date so there will be soap-tck-2.0.0.zip.

* [X]  attributes.conf: Update the following properties: {TechnologyRI} to EclipseGlassFish 6.0;  {TechnologyRIURL} to https://projects.eclipse.org/projects/ee4j.glassfish; {SpecificationInquiryList} to [jaxws-dev@eclipse.org](mailto:jaxws-dev@eclipse.org); {TCKPackageName} to jakarta-soap-tck-2.0.0.zip

* [X]  req-software.inc - Change first example, "Java EE 8 RI" to "Eclipse GlassFish 6.0 Compatible Implementation"

* [X]  install-server.inc - please update with current terminology (Java EE 8 RI -> Jakarta EE 9 Compatible Platform (some examples: Eclipse GlassFish 6); change RI to Compatible Implementation; Change software can be obtained from, to point to the Jakarta EE 9 Platform Specification page, or suggest the user can obtain a compatible implementation from Eclipse GlassFish 6).

* [X]  debug-tips.inc - please delete the code header at the top of this file. Otherwise, this header is rendered in Chapt. 6, Debugging Test Problems (debug.adoc).

* [X]  rebuild.inc - Please review this file and update language, component and package names (RI to Compatible Implementation, Etc.). This is rendered in Appendix B (rebuild.adoc).

* [X]  install/saaj/docs/SAAJ2.0-ReleaseNotes.html: please update the release date in the page title.

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

edbratt commented Jul 31, 2020

The final build target names were established by the Specification Committee. You can use this folder to find the final names of all TCKs generated by the release process by this project. I guess Local builds produce different file names. I wasn't aware of that.
I'll do another quick review with your latest updates ...

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

Thanks for the info. Name should be OK now.

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.

I will approve but there's one final thing I may have not pointed out previously: In faq.adoc, line 58 you could change: "reference implementation" to "Compatible Implementation".
Also in attributes.conf, if you could add a space between Eclipse and GlassFish, on link 5 (the definition of TechnologyRI, that would be cool also.

@@ -2,8 +2,8 @@
:TechnologyShortName: SOAP Attachments
:LegacyAcronym: SAAJ
:TechnologyVersion: 2.0
:TechnologyRI: GlassFish 6.0
:TechnologyRIURL: https://eclipse-ee4j.github.io/glassfish/
:TechnologyRI: EclipseGlassFish 6.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: add space: Eclipse GlassFish 6.0

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, fixed.

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

I just need someone to merge it. I'm not a commiter.

@edbratt edbratt merged commit 3108e60 into jakartaee:master Jul 31, 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