[jbossws-dev] Wiki documentation status

[Richard Opalka]

See inlined comments below ;-)

Alessio Soldano wrote:
> Hi Folks,
> yesterday and today I've spent some time checking the wiki 
> documentation and fixing some stuff to obtain better exports for the 
> release doc. Here is a list of  questions / things you might want to 
> be aware of:
>
> 1) thanks to some investigations, it has been figured out that 
> multiple wiki pages can be exported to docbook (and thus to html/pdf) 
> providing a list of articles in the wiki2xml form. See my previous 
> email for further details. The article list I would suggest for 
> exporting the release documentation is the following (perhaps the last 
> 4 entries could be excluded and a better article order could be chosen):
> User_Guide
> JBossWS_JAX-WS_Tools
> Authentication
> Secure_transport
> JAX-WS_Endpoint_Configuration
> JAX-WS_Client_Configuration
> Endpoint_management
> Records_management
> WS-Security_options
> FAQ
> JAX-WS_Annotations
> Wsconsume
> Wsprovide
> Wsrunclient
>
> 2) http://jira.jboss.org/jira/browse/JBWS-1961 allows links even to 
> sections to be correctly exported (otherwise links to articles only 
> are considered); http://jira.jboss.org/jira/browse/JBWS-1960 instead 
> allows images to be exported (absolute urls to images in html version, 
> embedded images in the pdf version). I did some successful tests on a 
> jbws mediawiki instance running on my laptop, please let me know 
> whether I can update the jbws.dyndns.org instance and how (I cannot 
> ssh to it). Once the up-to-date version of the wiki2xml plug-in is 
> online I could double-check the release documentation is exported the 
> right way.
>
> 3) all the new features going out from with 2.0.3 are now described or 
> referenced in the User Guide; as discussed on IRC with Heiko, this 
> includes the records management stuff. My only concern about this is 
> that the records management documentation also contains some 
> directions on how to use records with Metro and CXF stacks... but 
> 2.0.3 still has native only. Anyway I don't think this is actually a 
> real problem, let me know if you disagree with me.
>
> 4) there are some missing images linked in the user guide, does 
> someone have them and is able to upload them?
>
> 5) the user guide also links to 
> http://jbws.dyndns.org/mediawiki/index.php?title=Common_features_and_properties 
> that imho is still a work in progress. What is it meant to contain?
>
> 6) 
> http://jbws.dyndns.org/mediawiki/index.php?title=FAQ#What_JIRA_issues_are_backed_up_by_tests.3F 
> contains a list of jira issues backed up by tests... is there a rule 
> saying which issues should be mentioned here (since I see lots are 
> missing) or *all* jbwsXYZ should be included and we simply forgot 
> updating there since some time ;-) ?

I would remove this section from our Wiki. It's hard to maintain and I 
think release notes with mentioned important bug fixes is enough

>
> 7) http://jbws.dyndns.org/mediawiki/index.php?title=Interop_Endpoints 
> links to http://jbossws.demo.jboss.com that seems to be unavailable. 
> Where should we deploy the interop endpoints? Perhaps I could deploy 
> also the last ones I prepared in Seattle last November ;-)
>
> Thank you
> Cheers
> Alessio
> _______________________________________________
> jbossws-dev mailing list
> jbossws-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/jbossws-dev


-- 
B.Sc. Richard Opalka
Senior Software Engineer
JBoss, a division of Red Hat

Mobile: +420 731 186 942
Mail: ropalka at redhat.com