[richfaces-issues] [JBoss JIRA] Commented: (RF-10583) Review 4.0.0 project readme files, and update as possible

[Jay Balunas (JIRA)]

    [ https://issues.jboss.org/browse/RF-10583?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12585308#comment-12585308 ] 

Jay Balunas commented on RF-10583:
----------------------------------

readme-ui.txt feedback

* "This file explains how to obtain and install the RichFaces component 
library." 
** You already have the archive if you have this file ;-)
* Whole set of JSF2 benefits while working with AJAX.
** Lets change this to "Extends JSF2 basic Ajax capabilities with advanced extensions"
* "OBTAINING RICHFACES 4.X"
** I think we can get rid of this section - thoughts?
* I'm debating if we should provide information on where to get the dependencies for non-maven users.
** Good reason to use Maven ;-)
* After setting up the project to use RichFaces component
** "After updating your JSF 2 project dependencies for RichFaces"
** We should work in our archetype here perhaps as well?
* "Add on of the"
** "Add one of the"
* "http://www.jboss.org/community/wiki/RichFaces40Planning"
** "http://community.jboss.org/en/richfaces/dev"
* For the new in version XX
** Are you thinking of having this be for every version, or just the most recent 2-3, etc…?
** We'll need to write up something for Final
** I'll have to think about this more as well

Misc:
In the future we should setup build filters to update various parts.


> Review 4.0.0 project readme files, and update as possible
> ---------------------------------------------------------
>
>                 Key: RF-10583
>                 URL: https://issues.jboss.org/browse/RF-10583
>             Project: RichFaces
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>          Components: build/distribution, doc
>            Reporter: Jay Balunas
>            Assignee: Juan Camilo Prada
>             Fix For: 4.0.0.Final
>
>         Attachments: CR1 announce, readme-examples.txt, readme-showcase.txt, readme-ui-review-jay-01.txt, readme-ui.txt, readme-ui.txt, readme-ui.txt
>
>
> The readme files that are bundled with the distribution should be reviewed an updates with any additional information that would be helpful, or make them more clear.
> This could include formatting, more detailed explanations, new sections or links, etc...
> The primary files for this are :
> * http://anonsvn.jboss.org/repos/richfaces/branches/4.0.X/dist/readme-ui.txt
> * http://anonsvn.jboss.org/repos/richfaces/branches/4.0.X/dist/readme-examples.txt
> * http://anonsvn.jboss.org/repos/richfaces/branches/4.0.X/archetypes/richfaces-archetype-simpleapp/readme.txt
> ** http://anonsvn.jboss.org/repos/richfaces/branches/4.0.X/archetypes/richfaces-archetype-simpleapp/src/main/resources/archetype-resources/readme.txt
> * http://anonsvn.jboss.org/repos/richfaces/branches/4.0.X/examples/richfaces-showcase/readme.txt

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira