eclipse-ee4j / eclipse-ee4j/metro-wsit

Documentation issues

Open
#261 0 comments 0 reactions 0 assignees View on GitHub
Component: docs ERR: Assignee Priority: Major Type: Bug
Dominant language
Java
Stars
6
Forks
21
Avg merge
10h 2m
Merged PRs (30d)
1

Description

1)In the link: [https://metro.dev.java.net/nonav/1.0/docs/wsimportant.html](https://metro.dev.java.net/nonav/1.0/docs/wsimportant.html)
In section 2, wsimport task attributes, the description for attribute keep is
Keep generated files, "tunred" on with sourcedestdir option.But it should be,
Keep generated files,"turned" on with sourcedestdir option.

2)In the link [https://jax-ws-commons.dev.java.net/jaxws-maven-plugin/](https://jax-ws-commons.dev.java.net/jaxws-maven-plugin/)
This plugin contains Maven adapter for JAX-WS 's toolset. There is some white
space between JAX-WS and 's toolset.

3)In section 2.4\. Developing with
Eclipse([https://metro.dev.java.net/guide/Developing_with_Eclipse.html](https://metro.dev.java.net/guide/Developing_with_Eclipse.html))

* At step 2.4.2 ,Create a Metro Web Services Endpoint , Step 2 doesn't have
description.
* In Section 2.4.3 Creating web service client using WSImport CLI,

Open a command window and go into the source directory of that project
in Eclipse. For example, if the Eclipse workspace is in path ,
C:\home\vivekp\workspace and the name of the project is ehostringclient
,then you need to go to C:\home\vivekp\workspace\helloworld\src
But if the name of the project is "echostringclient", then the above line
should be changed to C:\home\vivekp\workspace\echostringclient\src

* In Step 2.4.5 Creating Web Service Client using SOAP UI Plugin,Select
"Help"/"Software Updates"/"Find and Install..."
o Press the "New Remote Site" button and add
[http://www.soapui.org/eclipse/update/site.xml](http://www.soapui.org/eclipse/update/site.xml) as the plugin URL
The above steps are not valid in the latest version of Eclipse(Eclipse
Platform Version: 3.4.0 Build id: I20080617-2000) .
To add a new site, in the latest version of eclipse these are steps to
follow:
Select "Help"/"Software Updates"/"In available Software tab-->Add Site"
([http://www.soapui.org/eclipse/update/site.xml)--](http://www.soapui.org/eclipse/update/site.xml)--)>Click OK.

4)Section 2.5 Developing with IDEA is still
pending([https://metro.dev.java.net/guide/Developing_with_IDEA.html](https://metro.dev.java.net/guide/Developing_with_IDEA.html))

5)In Section 2.6 Useful tools for your toolbox
([https://metro.dev.java.net/guide/Useful_tools_for_your_toolbox.html](https://metro.dev.java.net/guide/Useful_tools_for_your_toolbox.html)),
the link pointing to HttpSpy([http://www.snapfiles.com/get/httpspy.html](http://www.snapfiles.com/get/httpspy.html)) is
currently not available.Should give a new location

6)Can this([https://metro.dev.java.net/guide/Logging.html](https://metro.dev.java.net/guide/Logging.html)) page be edited so that
we don't have much horizontal scrolling?

7)In the link [https://metro.dev.java.net/guide/Deploying_Metro_endpoint.html](https://metro.dev.java.net/guide/Deploying_Metro_endpoint.html),
Section 2.9.3 Using 109 Deployment
Descriptor([https://metro.dev.java.net/guide/Deploying_Metro_endpoint.html#Using_109_Deployment_Descriptor](https://metro.dev.java.net/guide/Deploying_Metro_endpoint.html#Using_109_Deployment_Descriptor))
is still incomplete.

8)In Section 2.11.3 Using -wsdlLocation
switch([https://metro.dev.java.net/guide/Developing_client_application_with_locally_packaged_WSDL.html#Using__wsdlLocation_switch](https://metro.dev.java.net/guide/Developing_client_application_with_locally_packaged_WSDL.html#Using__wsdlLocation_switch))
the link I am using Metro 1.5 M5 is referring to an invalid location.

9)In Section
2.12.1([https://metro.dev.java.net/guide/How_to_invoke_and_endpoint_by_overriding_endpoint_address_in_the_WSDL.html#BindingProvider_ENDPOINT_ADDRESS_PROPERTY](https://metro.dev.java.net/guide/How_to_invoke_and_endpoint_by_overriding_endpoint_address_in_the_WSDL.html#BindingProvider_ENDPOINT_ADDRESS_PROPERTY)),
in the example, the html tag is not parsed by the browser.

10)In Section 12.3.4.1, Transport Security (SSL) Workaround
([https://metro.dev.java.net/guide/Security_Mechanisms.html#Transport_Security__SSL__Workaround](https://metro.dev.java.net/guide/Security_Mechanisms.html#Transport_Security__SSL__Workaround)),
we see special characters in the code section.For this we need to reload the
page for the special characters to go.
This is seen through out the documentation .

12)In the section 12.3.4.1 ,in the work around example the method verify has
pipes surrounding the argument hostname.These should be removed.

public boolean verify(String |hostname|,javax.net.ssl.SSLSession sslSession)
#### Environment
Operating System: All
Platform: All
#### Affected Versions
[current]

Source: [https://github.com/javaee/metro-wsit/issues/994](https://github.com/javaee/metro-wsit/issues/994)
Author: glassfishrobot

Contributor guide

Open the contributing guide

Research direction

Review the linked Metro documentation pages and the listed sections, beginning with the wsimport attributes and Eclipse instructions. Check each reported typo, broken link, missing or incomplete section, outdated procedure, and rendering issue against the current documentation. Done means the documented corrections, valid links, complete instructions, and readable code examples are verified across all affected pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.