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

[Sande Gilda (JIRA)]

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

Sande Gilda commented on JBDS-2727:
-----------------------------------

The updated guide is here: https://github.com/jboss-developer/jboss-eap-quickstarts/blob/master/CONTRIBUTING.md#quickstart-cheat-sheet-contributing-guide

Under "Basic Steps to Create a Cheat Sheet", I added:

3. 4. Select item, then under Command, click browse and select 'Get current project' under Uncategorized. This adds the following XML to the cheat sheet:

<command 
required="true" 
returns="currentProject"
serialization="org.jboss.tools.project.examples.cheatsheet.getProjectForCheatsheet"/>

This command allows you to use the variable ${currentProject} instead of a hard-coded path name and ensures your cheat sheet will work regardless of the project location.


Under "General Guidelines", I added: 
Make sure you add the 'Get current project' command and use the replaceable ${currentProject} value to avoid hard-coding the project path. This ensures that if the quickstart folder is moved, the cheat sheet will work as expected.


                
> 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, requirements
>            Reporter: Burr Sutter
>            Assignee: Fred Bricon
>         Attachments: CHEATSHEET-CONTRIBUTING.html, CHEATSHEET-CONTRIBUTING.md
>
>
> 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