Bug 1011833 - Quickstarts don't include readme.html files
Summary: Quickstarts don't include readme.html files
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Quickstarts
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ER7
: EAP 6.2.0
Assignee: sgilda
QA Contact: Vladimir Rastseluev
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-09-25 08:32 UTC by Vladimir Rastseluev
Modified: 2017-10-10 00:22 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-12-15 16:17:40 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Vladimir Rastseluev 2013-09-25 08:32:14 UTC
Description of problem:
all quickstarts directories doesn't include readme.html files

Version-Release number of selected component (if applicable):
EAP 6.2.0 ER3

Comment 1 sgilda 2013-10-01 12:07:22 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?

Comment 2 sgilda 2013-10-01 16:04:39 UTC
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?

Comment 3 Vladimir Rastseluev 2013-10-01 16:37:57 UTC
As I can see, *.md files contain links I can't use to look up resources. Am I doing something wrong?

Comment 4 sgilda 2013-10-01 16:49:12 UTC
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/

Comment 5 Vladimir Rastseluev 2013-10-01 17:23:17 UTC
I doubt, that customer downloaded quickstarts will be able to see anything on his local machine.

Comment 6 sgilda 2013-10-08 19:10:56 UTC
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

Comment 7 Vladimir Rastseluev 2013-10-10 09:13:03 UTC
Verified on EAP 6.2.0 ER5.1

Comment 8 sgilda 2013-10-25 14:42:25 UTC
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.

Comment 9 Vladimir Rastseluev 2013-10-31 06:37:54 UTC
Verified on EAP 6.2 ER7


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