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

[Jozef Hartinger (JIRA)]

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

                 Key: WELD-650
                 URL: https://jira.jboss.org/browse/WELD-650
             Project: Weld
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 1.1.0.Beta1
            Reporter: Jozef Hartinger
            Assignee: Pete Muir
         Attachments: code_samples.png

readme.txt
- the second paragraph says "This is feature complete release of the CDI specification." IMHO it should say "This is a feature complete implementation of the CDI specification."
- the licensing section says "the Apache License, Version 2.0" it should say "ASL 2.0" or "Apache Source License 2.0"
- Source code reference should be "http://github.com/weld" not "http://anonsvn.jboss.org/repos/weld"

examples/readme.txt
- the pastecode example is not mentioned
- se/helloworld should be se/hello-world
- remove wicket example reference

examples/se/numberguess/readme.txt
- mentions Web Beans
- restricts maven to version 2 (maven 3 users should not be limited)

examples/se/helloworld/readme.txt
- mentions Web Beans
- instructions are wrong (examples/se/hello-world should be used instead of examples/se/numberguess)
- restricts maven to version 2 (maven 3 users should not be limited)

Javadoc
- doc/apidoc contains CDI javadoc only (no Weld-specific docs)

Reference documentation
- remove wicket references - entire section 7.2
- update SCM references (Chapter 17)
- code sample references (numbers) not rendered correctly in the HTML version (see the attached screenshot)

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