[UB]Add consistency in docs when referring to configuration properties and their values

[glassfishrobot]

The following suggestion would help intorduce consistency in the docs when references are made to configuration settings - i.e. the property names and values.

Whenever an AS configuration setting is being referred to, it sould be identifyable as such - e.g. the property that controls the JMS service type and the values that this property can have – i.e. "EMBEDDED", "LOCAL" and "REMOTE"

The docs needs to refer to the property by the actual name and perhaps also provide a pointer to the reference page/man page for that property and when the docs refer to a value for the property, the font characters used to for the value need to be distinct so that the user knows that this is a value and can be used as is (literal) on the command line or can identify this as such in the GUI.

As an example I picked out some text below that was in the process of being updated,btu which highlights the enhancement request.

---

Message Queue varhome Directory

The Sun Java System Message Queue software uses a default directory for storing persistent data such as messages and log files. This is called the varhome directory.

When the Application Server controls the life cycle of the Message Queue Broker (i.e. when the JMS Service Type is either EMBEDDED or LOCAL), then the Application Server configures Message Queue to use /imq as the varhome directory.

When the life cycle of the Message Queue Broker is managed independently, (i.e. when the JMS Service Type is REMOTE), then the varhome directory is configured by the administrator of Message Queue.

The use of the following line –

(i.e. when the JMS Service Type

should lead the user to immediately understand that a configuration property is being referred to here and more info can be found at xxxx and if the values are YYYY or ZZZZ , then such and such is the behavior.

The user should be able to identify that YYYY and ZZZZ are propert values.

Hope this explains the issue sufficiently.

-George

Environment

Operating System: All Platform: All

Affected Versions

[v2.1]

[glassfishrobot]

• Issue Imported From: https://github.com/javaee/glassfish/issues/5190
• Original Issue Raised By:@glassfishrobot
• Original Issue Assigned To: @yaminikb
• Original Issue Closed By:@glassfishrobot

[glassfishrobot]

@glassfishrobot Commented pauldavies said: Added [UB] to Summary to denote "unbundled" documentation.

[glassfishrobot]

@glassfishrobot Commented pauldavies said: Target milestone is V3

[glassfishrobot]

@glassfishrobot Commented pauldavies said: Changed to Enhancement

[glassfishrobot]

@glassfishrobot Commented kumara said: Changing version from 9.1.1 to v2.1 to reflect new name/version.

[glassfishrobot]

@glassfishrobot Commented pauldavies said: This issue is potentially open ended and, therefor, almost possible to fix. Therefore, I am limiting the scope of this issue to the examples cited by reassigning it to Mike Fitch to fix in the Message Queue documentation.

[glassfishrobot]

@glassfishrobot Commented oncered said: The JMS sections of the GlassFish Administration Guide GlassFish High Availability Administration Guide underwent significant reworking for the 3.1 release, and I believe the rework addresses your concern. If not, please reopen this issue.

[glassfishrobot]

@glassfishrobot Commented Was assigned to oncered

[glassfishrobot]

@glassfishrobot Commented This issue was imported from java.net JIRA GLASSFISH-5190

[glassfishrobot]

@glassfishrobot Commented Reported by tharakan

[glassfishrobot]

@glassfishrobot Commented Marked as fixed on Tuesday, July 19th 2011, 2:55:42 pm