| Summary: | Quickstarts don't include readme.html files | ||
|---|---|---|---|
| Product: | [JBoss] JBoss Enterprise Application Platform 6 | Reporter: | Vladimir Rastseluev <vrastsel> |
| Component: | Quickstarts | Assignee: | sgilda |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Vladimir Rastseluev <vrastsel> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 6.2.0 | CC: | benevides, bsutter, pgier, pmuir, pslavice, vrastsel |
| Target Milestone: | ER7 | ||
| Target Release: | EAP 6.2.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-12-15 16:17:40 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: | |
|
Description
Vladimir Rastseluev
2013-09-25 08:32:14 UTC
The community version of the quickstarts do not contain the README.html files. Pete: Do we want to add them for the product branch? I spoke with @pmuir and he believes we should not provide HTML files for the README.md files. Can you give me a compelling reason why we need this? As I can see, *.md files contain links I can't use to look up resources. Am I doing something wrong? No. When you view the README in GitHub or on the JDF site, the links appear. For example, the bean-validation quickstart README.md file renders here: http://site-jdf.rhcloud.com/quickstarts/jboss-as-quickstart/bean-validation/ I doubt, that customer downloaded quickstarts will be able to see anything on his local machine. Updated instructions to use 'mvn clean install' and generated README.html files in this pull: https://github.com/jboss-developer/jboss-eap-quickstarts/pull/654 Verified on EAP 6.2.0 ER5.1 Reopening this bug. On IRC today, Marek Schmid, Rafael Benevides, Paul Gier and I discussed this issue. It really does not make sense to add the HTML files to GitHub.THe markdown is the file of record and it is difficult to keep the html file in sync with it. Instead, Paul will run the 'dist/release-utils.sh -m' script as part of the release process to generate the HTML files. This will assure that they are update to date and valid. I will be submitting a pull to revert this change. Verified on EAP 6.2 ER7 |