Bug 1087548 - Chapter 8.4. Implement an HA Singleton duplicates a lot of information from the corresponding quickstart
Summary: Chapter 8.4. Implement an HA Singleton duplicates a lot of information from t...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Documentation
Version: 6.3.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ER7
: EAP 6.3.0
Assignee: sgilda
QA Contact: Ladislav Thon
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-04-14 15:14 UTC by Ladislav Thon
Modified: 2014-08-14 15:19 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build Name: 22509, Development Guide-6.3-1 Build Date: 11-04-2014 10:19:00 Topic ID: 9154-627680 [Latest]
Last Closed: 2014-06-28 15:27:55 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Ladislav Thon 2014-04-14 15:14:45 UTC
Title: Implement an HA Singleton

Describe the issue:

The chapter 8.4. Implement an HA Singleton refers to the "cluster-ha-singleton" quickstart, but then goes on to show code and various configuration details, all of them being duplicated from the quickstart. Moreover, the text in this chapter ages a lot faster than the quickstart (which also undergoes much more rigorous QA).

Suggestions for improvement:

Make this chapter a lot shorter. Basically, just explain that there is this quickstart and that the quickstart shows how to implement clustered singleton and clustered singleton timer (which are two different things).

The note about SingletonService being private API and about public API being planned for EAP 7 is the most important thing here, that one should definitely remain. The rest is just details that can be found elsewhere in the documentation.

Additional information:

Just a suggestion. You are of course allowed to bring the code in the documentation up to date with the quickstart etc :-) I just don't think this duplication is necessary.

Comment 1 sgilda 2014-05-27 19:50:13 UTC
See related Bug 1012084.

Comment 2 sgilda 2014-06-11 20:37:53 UTC
I have already updated the topic to match the quickstart code to fix the other bug. I'm reluctant to remove it at this point. Maybe for the next release?

Here's the link:

http://documentation-devel.engineering.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.3/html-single/Development_Guide/index.html#Implement_an_HA_Singleton

If you feel strongly about cutting it out, let me know, but this was created based on another bug. :-)

Comment 3 Ladislav Thon 2014-06-12 05:57:29 UTC
It's your decision in the end :-) I've seen the other bug and as of now, the topic is OK, so I'm marking this verified.


Note You need to log in before you can comment on or make changes to this bug.