Bug 1061682 - Maven repo: README file is missing
Summary: Maven repo: README file is missing
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss BRMS Platform 6
Classification: Retired
Component: Documentation
Version: 6.0.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ER3
: 6.0.2
Assignee: Petr Kočandrle
QA Contact: Petr Široký
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-02-05 12:17 UTC by Petr Široký
Modified: 2014-08-06 19:59 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-08-06 19:59:10 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Petr Široký 2014-02-05 12:17:06 UTC
Description of problem:
The Maven repo zip should contain a README file with the information about the repo, how to use it, etc.


Version-Release number of selected component (if applicable):
6.0.0-CR2

Comment 2 Rajesh Rajasekaran 2014-02-18 21:03:21 UTC
We plan to have official documentation in one of the guides on how to use the maven repo. Turning this over to the docs team.

Comment 4 Vikram Goyal 2014-03-13 06:47:07 UTC
This has now been documented in the Installation Guide for BPM Suite [1].

Note that since the Maven repo is part of the overall suite of JBoss Integration products, this topics is shared between JBoss DV and JBoss FSW and therefore contains steps for those products as well.

Moving this to ON_QA.

[1] http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/Installation_Guide/index.html#chap-JBoss_Integration_Maven_Repository

Comment 5 Petr Široký 2014-03-13 10:52:09 UTC
Documenting the Maven repo usage in the official docs is great. However I think we should include also the README file inside the repo zip. If you, for example, download eap-6.1.1 repository or wfk-2.4.0 repository, they both contain README file explaining basic steps needed to install/use the repo. Is there a reason to _not_ provide such file in the repo zip?

Comment 7 Rajesh Rajasekaran 2014-03-17 20:45:28 UTC
Initially we had the notion of one maven repo for all integration products (that's what you see in http://maven.repository.redhat.com/techpreview/ip6/ ) but then we dropped this and started to ship a separate repo for each product.
Hence I'm not sure if "JBoss Integration Maven Repository" is valid any more, I don't think we depend on any component from FSW or DV, only EAP6.

Comment 13 Petr Široký 2014-04-29 12:37:41 UTC
The README is not part of the zip distribution. I am not sure if it should or sould not be included. In case the it should not, please close this BZ as not a bug.

Comment 14 Petr Široký 2014-05-28 14:50:28 UTC
Verified fixed in 6.0.2.ER3, simple README is included.


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