[jbosstools-issues] [JBoss JIRA] (JBDS-2727) Cheatsheets for JBoss Central archetypes

[Michelle Murray (JIRA)]

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

Michelle Murray commented on JBDS-2727:
---------------------------------------

[~maxandersen], the impact on docs of cheat sheets accompanying all JBoss Central archetypes is as follows:
* Any procedures that detail using an archetype wizard will need an extra comment that the cheat sheet opens at the end
* Getting Started Guide = 5.3 Create a Java EE Web Project, add note about cheat sheet opening
* User Guide, JBoss Central chapter =
** 2.1.1 About JBoss Central - add note that project wizards have cheat sheets
** 2.2.3 Access Project Wizards in JBoss Central - add note that projects accompanied by cheat sheet which auto opens in Cheat Sheet tab when wizard completes
** 2.2.8 View Cheat Sheets - add that some/all archetypes in JBoss Central are accompanied by cheat sheets and cheat sheet automatically opens when wizard completes; change example in screen captures to be for a JBoss Central archetype
*** Figure 2.13. Cheat Sheet Open in Cheat Sheets Tab
*** Figure 2.14. Open In Cheat Sheets View Menu Option

                
> Cheatsheets for JBoss Central archetypes
> ----------------------------------------
>
>                 Key: JBDS-2727
>                 URL: https://issues.jboss.org/browse/JBDS-2727
>             Project: Developer Studio (JBoss Developer Studio)
>          Issue Type: Feature Request
>      Security Level: Public(Everyone can see) 
>          Components: central
>            Reporter: Burr Sutter
>
> Our archetypes should have cheatsheets when imported/opened into eclipse.
> Priority
> 1) HTML5 - cheatsheet should focus the end-user's attention on index.html, editable in the VPE, with the jQuery Mobile Palette, it should also describe LiveReload setup and BrowserSim
> 2) Java EE Web - cheatsheet should focus the end-user's attention on index.xhtml, editable in the VPE, with the JSF/RichFaces Palette.  It should describe the JPA Member.java, the relationship between MemberController.java and index.xhtml, the purpose of MemberResourceRESTService.java and JaxRsActivator.java
> Basically walk the user through the flow of events (from the UI to the backend) in the application 
> 3) RichFaces - cheatsheet should focus the end-user's attention on index.xhtml, editable in the VPE, with the JSF/RichFaces Palette. It should also describe resources/components/memberForm.xhtml and its use of <rich:validator/> and that tag's relationship with the JPA beanvalidations

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira