JBehave
  1. JBehave
  2. JBEHAVE-235

Improve documentation on running trader example with reports

    Details

    • Type: Task Task
    • Status: Resolved Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.4
    • Fix Version/s: 2.4.1, 2.5
    • Component/s: Documentation
    • Labels:
      None
    • Environment:
      Mac OS X 10.6.2, mvn 2.2.1
    • Number of attachments :
      0

      Description

      I checked out https://svn.codehaus.org/jbehave/trunk/core/examples/trader referenced on http://jbehave.org/reference/latest/reports.html and running mvn test did not succeed as:

      • there is no jbehave-examples-2.5-SNAPSHOT parent pom available from the standard maven repositories.
      • there is no mentioning which mvn command I should invoke to create the report.

      Checking out the whole core trunk at https://svn.codehaus.org/jbehave/trunk/core/, running mvn install, changing to expamples/trader afterwards and running mvn clean integration-test site would produce the expected output at target/jbehave-reports/rendered/index.html.

        Activity

        Mauro Talevi made changes -
        Field Original Value New Value
        Summary trader example on http://jbehave.org/reference/latest/reports.html not working out of the box. Improve documentation on running trader example with reports
        Hide
        Mauro Talevi added a comment -

        Added README.txt examples:

        https://svn.codehaus.org/jbehave/trunk/core/examples/README.txt

        Do let me know if it's exhaustive or it needs more clarification.

        Note that you need to build at least once all examples, not just trader as the examples parent POM sets up common config for all examples. I'll add a note to the documentation on running examples too.

        Show
        Mauro Talevi added a comment - Added README.txt examples: https://svn.codehaus.org/jbehave/trunk/core/examples/README.txt Do let me know if it's exhaustive or it needs more clarification. Note that you need to build at least once all examples, not just trader as the examples parent POM sets up common config for all examples. I'll add a note to the documentation on running examples too.
        Hide
        Mirko Friedenhagen added a comment -

        The README.txt is good .

        Then I would update http://jbehave.org/reference/latest/reports.html to include at least a hint on the README.txt ala:

        For build instructions see https://svn.codehaus.org/jbehave/trunk/core/examples/README.txt

        Show
        Mirko Friedenhagen added a comment - The README.txt is good . Then I would update http://jbehave.org/reference/latest/reports.html to include at least a hint on the README.txt ala: For build instructions see https://svn.codehaus.org/jbehave/trunk/core/examples/README.txt
        Hide
        Mauro Talevi added a comment -

        Added doc page: http://jbehave.org/reference/latest/running-examples.html

        Updated reports page to reference it.

        Show
        Mauro Talevi added a comment - Added doc page: http://jbehave.org/reference/latest/running-examples.html Updated reports page to reference it.
        Mauro Talevi made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Fix Version/s 2.5 [ 15850 ]
        Resolution Fixed [ 1 ]
        Mauro Talevi made changes -
        Affects Version/s 2.5 [ 15850 ]
        Affects Version/s 2.4 [ 15664 ]
        Mauro Talevi made changes -
        Fix Version/s 2.4.1 [ 16188 ]
        Mauro Talevi made changes -
        Issue Type Improvement [ 4 ] Task [ 3 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Mirko Friedenhagen

            Dates

            • Created:
              Updated:
              Resolved: