[weld-issues] [JBoss JIRA] Created: (WELD-283) Documentation issues

Jozef Hartinger (JIRA) jira-events at lists.jboss.org
Thu Nov 12 04:20:06 EST 2009


Documentation issues
--------------------

                 Key: WELD-283
                 URL: https://jira.jboss.org/jira/browse/WELD-283
             Project: Weld
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 1.0.0.GA
            Reporter: Jozef Hartinger
             Fix For: 1.0.0.GA


Global problems
- a significant number of links is missing the value of href attribute (these links point nowhere)
- the JBoss AS 5.2.x have become obsolete recently (changed to 6.0.0.M1) - the documentation references this obsolete version. i.e. Chapters 6, section 18.1
- there is a number of unnecessary blank pages in the PDF version

- Section 2.1.2. Scope - there is a missing *want* in the Note in the sentence: "If you don't the bean to live in the session indefinitely..."
- Section 6.2 Deploying to JBoss AS - there is a missing space in the sentence "Create a new file namedlocal.build.properties ..."
- Section 6.2 Deploying to JBoss AS - is not finished - there is a TODO at the very end of the section
- Secion 7.1. The numberguess example in depth - the numbers which mark an important line of a code sample (1), (2), etc... are broken in the second sample of the section (web.xml). They are placed on wrong places (wrong line, beggining of the line instead of end) and they are followed by  "ml_plain">" in the HTML version.

Besides, I would emphasize more the benefit of the typesafe resolution i.e. in section 1.2 - (that all the unsatisfied and ambiguous dependencies are discovered at the deployment time - you do not need to click anything to find out that the you set some dependencies wrong - more formal verification) - I don't say it is not there already. I just had a feeling that it is not stated explicitly enough.


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


More information about the weld-issues mailing list