Bug 837481
| Summary: | Topics that require location information according to Docs QE Feedback | ||
|---|---|---|---|
| Product: | [JBoss] JBoss Data Grid 6 | Reporter: | gsheldon |
| Component: | Documentation | Assignee: | Misha H. Ali <mhusnain> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | John Skeoch <jskeoch> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 6.0.0 | CC: | jdg-bugs, mgencur |
| Target Milestone: | --- | ||
| Target Release: | 6.0.1 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2012-09-20 03:48:08 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: | |
| Embargoed: | |||
|
Description
gsheldon
2012-07-04 04:57:53 UTC
Adding John. This issue requires clarification from SMEs when they return from Summit. The original bug will be closed as normal, attesting to all QE issues addresses but this one. location information provided by Pmuir. On the JDG_QE pad for confirmation. Will set to ON_QA once the information is confirmed and the change appears on the stage. http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Data_Grid/6/html-single/Getting_Started_Guide/index.html#Using_a_Named_Cache locations will appear on the stage shortly. Gemma, please coorindate with Martin to get someone from QE to review that the information provided is accurate before release. Gemma, please coorindate with Martin to get someone from QE to review that the information provided is accurate before release. Martin Please check the location information provided here: http://documentation-devel.engineering.redhat.com/docs/en-US/JBoss_Data_Grid/6/html/Getting_Started_Guide/Register_the_Named_Cache_Programmatically.html Martin's feedback (via email):
"We should not point to Infinispan's download page so I would remove the
"The Infinispan Project's Downloads page." link.
The second link is fine. ("The Infinispan Github Repository.")
If this documentation is going to be available for JDG 6.0.1, we should
remove the "Important" note that quickstarts are only a technical preview.
Furthermore, the quickstarts are using Infinispan bits, not JDG. It
would be good if we mentioned that users should replace Infinispan's
dependencies with those from JDG."
Setting back to assigned while I address this.
Tech Preview comments removed from http://documentation-devel.engineering.redhat.com/docs/en-US/JBoss_Data_Grid/6/html/Getting_Started_Guide/sect-Configure_the_Maven_Repository.html and http://documentation-devel.engineering.redhat.com/docs/en-US/JBoss_Data_Grid/6/html/Getting_Started_Guide/chap-Run_JBoss_Data_Grid_as_an_Embedded_Cache.html#Quickstart_File_Locations Have included "Important These quickstarts have been written for the Infinispan community project. In order to deploy these quickstarts in JBoss Data Grid, remember to replace Infinispan dependencies with those from JBoss Data Grid. " in Quickstart File Locations topic. I'm sorry Gemma. I previously ACKed the statement about quickstarts. However, it should be rephrased a bit. We cannot deploy anything in JDG so the second sentence could confuse users. Lets' say: "In order to run these quickstarts, remember to replace ..." No problem Martin. I've changed this to "These quickstarts have been written for the Infinispan community project. In order to run these quickstarts in JBoss Data Grid, remember to replace Infinispan dependencies with those from JBoss Data Grid" as suggested. I take it this is ok now? Rephrased to "These quickstarts are written for the Infinispan community project. To run these quickstarts in JBoss Daya Grid, replace Infinispan dependencies with JBoss Data Grid dependencies." |