Uploaded image for project: 'jBPM'
  1. jBPM
  2. JBPM-2486

jbpm4 user guide : small errors in doc

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • Major
    • jBPM 4.1
    • jBPM 4.0
    • None
    • None

    Description

      forum : http://www.jboss.org/index.html?module=bb&op=viewtopic&t=159875

      two points I noticed :

      1/
      http://docs.jboss.com/jbpm/v4.0/userguide/html_single/#deployingaprocess

      the given example is :
      "
      long deploymentDbid = repositoryService.createDeployment()
      .addResourceFromClasspath("org/jbpm/examples/services/Order.jpdl.xml")
      .deploy();
      "

      but in fact deploy() returns a String

      could someone correct it ?

      2/
      same kind of inaccurracy : the id in table 5.1 and 5.2 has a format like

      {key}:{version} (with : between key and version)
      whereas the text above states :
      "The id will have format {key}

      -

      {version}

      with a dash between key and version"
      and paragraph 5.6.2 seems to use this "dash" format too

      if I may insist doc quality really matters...

      a third point :

      3/ in § 6.2.3.1. Decision conditions there should be an image with url
      http://docs.jboss.com/jbpm/v4.0/userguide/html_single/images/process.decision.png

      but there is nothing at this URL, so that the image does not show. I suppose the correct URL would be :
      http://docs.jboss.com/jbpm/v4.0/userguide/html_single/images/process.exclusive.png

      idem with the two follwing images

      4/ Figure 6.20 is not accurate eithet, I'd say

      5/ Figure 6.24 also not correct

      6/ in the listings and comments §6.5.1. Event listener example there is
      "LogListener will maintain a list of logs in a static member field:"
      but it is obviously not a static field. But those comments may be confusing, because the concept of process variable is new for most reader, I think. Plus it is wrong

      Attachments

        Issue Links

          Activity

            People

              jbarrez Joram Barrez (Inactive)
              npirard_jira Nicolas Pirard (Inactive)
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 10 minutes
                  10m