Bug 1092026
| Summary: | Target Product entry in quickstarts readme files should contain official product name | ||
|---|---|---|---|
| Product: | [JBoss] JBoss Enterprise Application Platform 6 | Reporter: | Nikoleta Hlavickova <nziakova> |
| Component: | Quickstarts | Assignee: | sgilda |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Nikoleta Hlavickova <nziakova> |
| Severity: | medium | Docs Contact: | Russell Dickenson <rdickens> |
| Priority: | unspecified | ||
| Version: | 6.3.0 | CC: | benevides, bsutter, jkudrnac, jporter, paul.robinson, pmuir |
| Target Milestone: | ER1 | Keywords: | Reopened |
| 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: | 2015-10-16 20:48:45 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-04-28 14:28:56 UTC
The 'Target Product:' and 'Product Versions:' are metadata tags that were created to be used by our JBoss Developer web site source code to build index adn build quickstart table information. The are also used by our quickstart automated tooling. Changing these tag values to use the full product name will require a lot man hours to make the changes to the web site code. There are many places where code changes are required to replace parsing and regex expressions. It will require less work to change the metadata tags as follows: Change 'Target Product:' to 'Product Codes:' Change 'Product Versions:' to 'Version Codes:' So you would end up with: Product Codes: EAP Version Codes: EAP 6.1, EAP 6.2, EAP 6.3 This will still require a massive undertaking, but will not be as risky for the web site. My first preference is to leave everything as it is. My second preference would be to change the tag names to indicate it they are code names. Would this be an acceptable fix? Could we rename the "fields"? Would that be acceptable? I'm obviously not a regular developer looking at the quickstarts, but I highly doubt people pay any attention to that once they've downloaded the code. This seems like a very minimal issue. Also, why is it being brought up now, that we have over 170 quickstarts? If it's a problem now, how was it missed back at EAP 6.0 launch? +1 to Change te field name I just want to clarify. Any change will impact quickstarts in the following repositories:. https://github.com/jboss-developer/jboss-brms-quickstarts https://github.com/jboss-developer/jboss-eap-quickstarts https://github.com/jboss-developer/jboss-jdg-quickstarts https://github.com/jboss-developer/jboss-on-quickstarts https://github.com/jboss-developer/jboss-picketlink-quickstarts https://github.com/jboss-developer/jboss-portal-quickstarts https://github.com/jboss-developer/jboss-sandbox-quickstarts https://github.com/jboss-developer/jboss-wfk-quickstarts https://github.com/richfaces/jdf-quickstarts All changes must be coordinated with the web site source code so that we do not break the web site. My vote is still to leave them as they stand now. I just thought of another problem. The web site looks for the current shipping or tagged quickstarts. The quickstarts for different products ship at different times, so changing the tags for the development branches would break the web site. We would also need to change the quickstart README files for the released quickstarts, like WFK 2.4. This seems extremely risky to me. I am going to reject this one. If someone wants to escalate it, will reconsider. It looks like we are going to remove the 'Product Versions' and change the target product to 'JBoss EAP'. We need to coordinate these changes with the www.jboss.org web site. Made the following changes: Changed 'Target Product: EAP ' to 'Target Product: JBoss EAP ' Rremoved 'Product Versions' line. Made sure the first line under 'What is it?' contained the full product name 'Red Hat JBoss Enterprise Application Platform' in every README file. Fixed in this commit: https://github.com/jboss-developer/jboss-eap-quickstarts/commit/7a051ba780125adad87cf82b9fe461bbb60a18d6 Verified with EAP 6.4.0.ER1. |