[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=12583797#comment-12583797 ] 

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

The only problem with having known issues be part of these documents is that they are tagged with the release, and can not really be updated.  We will have a separate release note document that is uploaded.

I like the "New in this version" section.  It could be scoped to the specific file.  i.e. the example one would discuss new example items, the main readme would discuss high level updates.  The question here is does this cover all of 4.0.0, or just the difference between CR1 & Final?  I would think the first.

> 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
>             Fix For: 4.0.0.Final
>
>
> 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