| Summary: | fixes required for JBPM Users Guide | ||
|---|---|---|---|
| Product: | [JBoss] JBoss Enterprise SOA Platform 4 | Reporter: | Dana Mison <dmison> |
| Component: | Documentation | Assignee: | Dana Mison <dmison> |
| Status: | CLOSED NEXTRELEASE | QA Contact: | |
| Severity: | high | Docs Contact: | |
| Priority: | high | ||
| Version: | 4.2 CP02 | ||
| Target Milestone: | --- | ||
| Target Release: | 4.2 CP04 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| URL: | http://jira.jboss.org/jira/browse/SOA-1124 | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2009-06-19 15:40:00 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
|
Description
Dana Mison
2009-01-13 23:47:36 UTC
P48, 6:
- "Typically, you make a copy the default configuration..." - doesn't make much sense.
- "The third part are some misc*a*llanious configurations..."
P50, 6.3: The whole chapter would look much better in a bullet-point list instead of naming every config file in its own subchapter with one sentence in it.
P51, 6.3.7: "The id*'*s are stored..." - please remove the apostrophe.
P51, 6.5: "Therefor*e*, by default, the ... *the that* *H*ibernate" - please add "e", remove "the" and make Hibernate use capital "H."
P55, 7.1.1: "The persistence API *is integrated with*..."
P58, 7.1.2: "As a result, a Hibernate session will *only be opened*"...
P59, 7.1.3:
- "The transaction attribute..." - please end the sentence with a full stop. Even better, put it in some other paragraph, as it's just one sentence.
- The following sentence begins with "the the".
P60, 7.2.1:
- first paragraph: names of the properties should be highlighted.
- seconds paragraph: we have an environment for important notes.
P62, 7.3: "and use the session per transaction pattern" - please, either put the "session per transaction" in quotes or join it using dashes.
P65, 7.6.3:
- "The jbpm.db subproject*,* contains..." - please remove
- "... scripts for all database*s*..."
P65, 7.7:
- "This can eliminate*s* ..." - please remove
- Secondly, this enable*s* ..."
P66, 7.8: The bullet-point list should either state sentences (first letter capital, last letter followed by a full-stop) or the first two bullet points should end with a comma (",") and the last one with a full-stop.
P70, 8.1.3: "... only takes a few minutes in *windows*." - I suggest we either use full name and state whose trademark is that, or we stop using our competitors' products in examples... :-)
P72, 8.1.4.1: "*To execution* this script..." - doesn't seem right.
P74, 8.1.4.2:
- "mysql -u root -p" - the username should be in italic as it depends on an environment. Also, once we do this, most of the next paragraph can be left out.
- "Once the script executes, you should have the foll*ow*ing..."
P76, 8.1.6: "Well, almost..." - I'd follow that with a line break.
P77, 8.1.6: "This section should look like shown in the listing below. There are
two changes in this file: the hibernate.connection.datasource property should point to the JbpmDS
datasource we created as the first step in this section and the hibernate.dialect property should match
the PostgreSQL or MySQL dialect." - properties should be highlighted.
P82: "You may have to ALT-TAB to get this application as it may be covered by another window." - I suggest we don't treat jBPM users as idiots who don't know anything about window management. :-) And if we do, Alt+Tab is heavily dependent on user's environment, so I'd left that out.
P88, 9.3.4:
- The first paragraph would be much better when converted into a bullet-point list with two items.
- Also, "Should the decision made by the process..." doesn't make much sense.
- "The first paragraph for which the *conditions resolves* to 'true'"... you can't have both words ending with "s" in this case.
P89, 9.4: "If more th*a*n..."
P93, 9.6.2: "... to distinct between..." - is "distinct" a verb?
P94, 9.7: s/serached/searched
P97, 9.10: s/implementated/implemented
P101, 10.1: "The most basic operations are*:*"
P102, 10.4.1: s/independant/independent
P103, 10.6: "hibernatable type" - really? :-) (Two occurences.)
P104, 10.6: "When you refer *to* your custom..."
P105, 10.6 type "LongInstance" should be highlighted.
P108, 11.2.2: "... one task instance *are* associated..."
P110, fig 11.1: Instances' arrows go into the boxes.
P110, 11.3.4: "*T*o specify the pooled actors..."
P111, 11.4: "The controller can be used to create*,* populate and ..."
P111, 11.5: Please remove the a) and b) from the bullet-point list.
P113, 11.6: s/assignements/assignments
P119, 12:
- "IMPORTANT NOTE": We have an environment for that, don't we?
- In the same paragraph, the repository method should be highlighted.
- Same comment for the bullet-point list as in "P66, 7.8"
- "a word document" - either use the full trademark name of Microsoft Word or don't mention the product at all. :-)
P121, 13.1:
- "A timer that is specified on a node*,* is not executed" - without the comma, please.
- Same comment for the bullet-point list as in "P66, 7.8"
P123, 14.2:
- "... by looking *at* two examples."
- "The first frame*,* show the..." - without the comma, please.
P124, 14.2: "Now, we are going to look at the second example, the second example is a variant..." - I smell redundancy...
P125, 14.2: "2 separate transactions*, o*ne transaction each part."
P127, 14.4:
- "... messages will be sen*t* by..."
- "... looks like this: " - the following list of items would IMHO look much better if it were an actual list.
P128, 14.4:
- "If for *one* reason or another..."
- "Limitation: " - this would look better in some sort of Note/Warning environment.
P128, 14.6: "... as asynchronous *w*as well as produce..." - remove the "w"
P129, 15.1:
- "As mentioned*,* the due date..."
- "... calculating the due* *date."
P129, 15.1.1: "Double.parseDouble(quantity)" - highlight, please.
P129, 15.1.2:
- "JbmException" - highlight, please.
- NOTE should actually become a Note.
P133, 16.1.1:
- "... resolved to email addresses with by means..." - remove "with", please.
- The next paragraph should end with a full-stop.
P134, 16.1.3:
- "... can be sen*t*..."
- "Setting notify to yes, true or on will..." - please highlight the values.
P134, 16.2: please end the first paragraph with a full-stop.
P135, 16.3.2: "actorId*'*s" - please remove the apostrophe.
P139, 17:
- "delta's" - please remove the apostrophe (2 times)
- "... much time is spen*t* on..."
P141, 17.3: s/ordered/order
P141, 17.4: s/queryies/queries
P143, 18.1.1:
- s/cfg is optional/optional
- s/properties is optional/optional
- "hibernate.cfg.xml" - please, highlight.
P144, 18.1.4: "... for which there *are* not yet" - replace with "is"
P145, 18.1.5: The java command should be highlighted, indirectory and outdirectory in italics. If made so, the following paragraph is probably not needed.
Please, make sure that these also get into SOA 4.3 CP/FP ${whatever}.
these have been updated in 4.3.CP01 updates have been applied to the docbook source Link: Added: This issue related SOA-1344 The final book will match the 4.3 CP01 book. Will close the JIRA when the final docs .zip is created. Verified in 4.2 CP04a docs here: http://jawa05.englab.brq.redhat.com/candidate/soa-4.2.0.GA_CP04/ |