Tools (JBoss Tools)
  1. Tools (JBoss Tools)
  2. JBIDE-12915

Kitchensink quickstart is missing .cheatsheet.xml

    Details

    • Steps to Reproduce:
      Hide

      Import Kitchensink quickstart from section "JBoss Developer Framework Quickstarts" of JBoss Central.
      FAIL - readme (or cheatsheet) should be shown.

      Show
      Import Kitchensink quickstart from section "JBoss Developer Framework Quickstarts" of JBoss Central. FAIL - readme (or cheatsheet) should be shown.
    • Similar Issues:
      Show 10 results 

      Description

      After importing Kitchensink example from section "JBoss Developer Framework Quickstarts" in JBoss Central, user is prompted to

      Show '/jboss-as-kitchensink/.cheatsheet.xml' for further instructions

      but /jboss-as-kitchensink/.cheatsheet.xml does not exist.
      Imported quickstart is named "kitchensink" instead of jboss-as-kitchensink and it has README.md instead of .cheatsheet.xml

        Activity

        Show
        Snjezana Peco
        added a comment - Fixed by https://github.com/jbosstools/jbosstools-download.jboss.org/pull/4
        Hide
        Radim Hopp
        added a comment -

        I just noticed, that this issue also concerns JBDS. Could you, please, fix this also in xml file for JBDS?
        Thanks

        Show
        Radim Hopp
        added a comment - I just noticed, that this issue also concerns JBDS. Could you, please, fix this also in xml file for JBDS? Thanks
        Hide
        Snjezana Peco
        added a comment -

        I have adapted the kitchensink quickstart and added it to the jdf quickstart project - https://github.com/jboss-jdf/jboss-as-quickstart/pull/363

        Show
        Snjezana Peco
        added a comment - I have adapted the kitchensink quickstart and added it to the jdf quickstart project - https://github.com/jboss-jdf/jboss-as-quickstart/pull/363
        Hide
        Fred Bricon
        added a comment -

        Applied in master

        Show
        Fred Bricon
        added a comment - Applied in master
        Hide
        Rastislav Wagner
        added a comment -

        verified in JBDS 6.0.0.CR1-v20121204-0201-B166

        Show
        Rastislav Wagner
        added a comment - verified in JBDS 6.0.0.CR1-v20121204-0201-B166
        Hide
        Snjezana Peco
        added a comment -

        I have updated the PR. Now, it uses the commands introduced by https://issues.jboss.org/browse/JBIDE-14333
        This cheatsheet will work with a project example based on an archetype if you copy a project to the workspace and import it or rename the project.

        The following are the main changes:

        1) At the beginning of the cheatsheet, you will see the following command:

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

        The command is obliged because it sets the currentProject variable.

        After that, the currentProject variable is used instead of the hard-coded project name.
        For instance:

        <command
        required="true" serialization="org.jboss.tools.project.examples.cheatsheet.openFileInEditor(path=/$

        {currentProject}/src/main/webapp/WEB-INF/templates/default.xhtml,fromLine=22,toLine=26

        or

        <action
        pluginId="org.jboss.tools.project.examples.cheatsheet"
        class="org.jboss.tools.project.examples.cheatsheet.actions.RunOnServer"
        param1="${currentProject}

        "/>

        Within the action, it is possible to use a variable like

        param1="$

        {currentProject}"

        but is not possible to use a variable as

        paramN="/${currentProject}

        /src/main/webapp/WEB-INF/templates/default.xhtml"

        The currentProject variable in the paramN attribute won't be translated which means the openFileInEditor command must be used instead of the org.jboss.tools.project.examples.cheatsheet.actions.OpenFileInEditor action.

        We also need to add the runOnServer and launchJUnitTest command.

        Show
        Snjezana Peco
        added a comment - I have updated the PR. Now, it uses the commands introduced by https://issues.jboss.org/browse/JBIDE-14333 This cheatsheet will work with a project example based on an archetype if you copy a project to the workspace and import it or rename the project. The following are the main changes: 1) At the beginning of the cheatsheet, you will see the following command: <command required="true" returns="currentProject" serialization="org.jboss.tools.project.examples.cheatsheet.getProjectForCheatsheet"/> The command is obliged because it sets the currentProject variable. After that, the currentProject variable is used instead of the hard-coded project name. For instance: <command required="true" serialization="org.jboss.tools.project.examples.cheatsheet.openFileInEditor(path=/$ {currentProject}/src/main/webapp/WEB-INF/templates/default.xhtml,fromLine=22,toLine=26 or <action pluginId="org.jboss.tools.project.examples.cheatsheet" class="org.jboss.tools.project.examples.cheatsheet.actions.RunOnServer" param1="${currentProject} "/> Within the action, it is possible to use a variable like param1="$ {currentProject}" but is not possible to use a variable as paramN="/${currentProject} /src/main/webapp/WEB-INF/templates/default.xhtml" The currentProject variable in the paramN attribute won't be translated which means the openFileInEditor command must be used instead of the org.jboss.tools.project.examples.cheatsheet.actions.OpenFileInEditor action. We also need to add the runOnServer and launchJUnitTest command.

          People

          • Assignee:
            Snjezana Peco
            Reporter:
            Radim Hopp
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: