Bug 1160163
| Summary: | Readme for forge-from-scratch quickstart references old product documentation | ||
|---|---|---|---|
| Product: | [JBoss] JBoss Enterprise Application Platform 6 | Reporter: | Nikoleta Hlavickova <nziakova> |
| Component: | Quickstarts | Assignee: | jboss-set |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Nikoleta Hlavickova <nziakova> |
| Severity: | medium | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 6.4.0 | CC: | bsutter, jkudrnac |
| Target Milestone: | ER1 | ||
| Target Release: | EAP 6.4.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2019-08-19 12:45:01 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
Nikoleta Hlavickova
2014-11-04 08:34:47 UTC
The instructions in the readme say about EAP 6.3. Please update those, too. ./forge-from-scratch/README.md:1. If you have not yet done so, add the JBoss EAP 6.3 runtime server to Red Hat JBoss Developer Studio. For more information, see [Set Up the Development Environment](https://access.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.2/html-single/Getting_Started_Guide/index.html#sect-Set_Up_the_Development_Environment). ./forge-from-scratch/README.md:2. Right mouse on the project name and choose `Run As` --> `Run on Server`. If you have more than one server, choose the JBoss EAP 6.3 Runtime server. ./forge-from-scratch/README.md:2. Expand the JBoss EAP 6.3 Server to see the list of deployed applications. Nikoleta, that quickstart needs updating to use Forge 2 and JDBS 8. The Forge team was waiting for the release of JDBS 8, which happened in the last few weeks. Matej will update the quickstart sometime in the next day or 2. The related bugs and JIRAs are: https://bugzilla.redhat.com/show_bug.cgi?id=1098701 https://issues.jboss.org/browse/JDF-706 I'm not closing this as a duplicate at this point because it provides extra tracking. Fixed in this commit: https://github.com/jboss-developer/jboss-eap-quickstarts/commit/ca6319c693565476119143eb8a0ab63bf4e690cd There are no references to EAP 6.3 in instructions now. However, the documentation reference was modified to https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_JBDS.md which points users to 6.3 docs, not the 6.4 one. I think we should not reference upstream documents in the product quickstarts because we cannot control its content. Please use link to product documentation in the readme. For other references of upstream documentation I will create a separate issue, this one will remain for the one in description only. The link to 'https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_JBDS.md' is not upstream. It was an attempt to consolidate common instructions in one location, rather than maintain 100+ readme files. Unfortunately, we can not refer to the JBoss EAP 6.4 documentation because it doesn't exist. I can modify the common instructions to be more generic or create new pages for specific release. I like the idea to have common instructions in one location. Could these possibly be included in EAP Quickstarts zip? This way I can verify them during quickstarts testing and see if something has changed there. If they are not part of the zip, they can change after the release which means we cannot guarantee they are correct. Ad. EAP 6.4 documentation does not exist - you are right, it does not exist yet. There is no need to create temporary or alternative solutions because of that. Documentation must be available for GA and we can wait with this until it is available. Creating pages for specific release is a good idea, because the instructions for EAP 6.4 can differ from the ones for EAP 6.3 and older releases. This could be solved by including them into zip as I mentioned above. What do you think? Nikoleta, the Forge quickstart requires JDBS 8.0 and I'm not sure it even talks about JBoss EAP 6.4. Since this quickstart runs on JBoss EAP 6.3, I don't believe I can make any changes yet, so I'm thinking about closing this as not a bug. Keeping this one open so I remember to create versioned JBDS instructions. The JBoss Developer Studio instructions have been updated in the JBoss EAP documentation for 6.4, so I'm moving this to ON_QA. I have created BZ 1182505 for the common instructions referencing old product documentation which can be fixed once we know the location of EAP 6.4 documentation. This one can be set as verified. |