hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Daniel Vimont (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-14877) maven archetype: client application
Date Wed, 27 Jan 2016 02:36:40 GMT

    [ https://issues.apache.org/jira/browse/HBASE-14877?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15118502#comment-15118502
] 

Daniel Vimont commented on HBASE-14877:
---------------------------------------

*README.md*
Yes, I much prefer using markdown for a README file, so it'll be a pleasure to convert it.
(I saw only README.txt files in the root folder and a few others, and had incorrectly assumed
that the project standard was txt files.) I'll also include the standard ASF license header
(which, btw, is also missing from the README.txt files in the root directory and the hbase-examples
directory -- and perhaps also missing from others).

*END-USER DOCUMENTATION*
Note importantly that the README text I've prepared is directed specifically at the audience
of _HBase contributors and committers_. It gets into the "how-to" of producing new archetypes.
The end-user can remain blissfully unaware of all of this; all the end-user will need to do
is execute a single Maven command:
{{mvn archetype:generate -Dfilter=org.apache:hbase}}
to interactively bring up a list of publicly-available HBase archetypes from which they may
choose.

Regarding end-user documentation, I hope it's okay to leave that to a separate subtask. I
would like to successfully get at least one publicly-available archetype loaded into the central
Maven archetype directory before finalizing end-user documentation (which will explain to
the end-user how to retrieve and use such an archetype). It would potentially sow confusion
if we publish the instructions before we finish tinkering around with deployment of our first
archetype to make it available.

*DEPLOYMENT*
In order to achieve deployment of a new hbase archetype to the Maven central repository, it
looks to me like we have to backport the archetype infrastructure (i.e. this patch) to a publicly-available
release -- at least 1.1.2 (and any other version for which archetypes should be made available)
-- http://mvnrepository.com/artifact/org.apache.hbase/hbase -- Is it correct that we need
to do such a backport, or am I missing something?

I originally developed this infrastructure against v1.1.2, so backporting to that version,
from my point of view, should be very easy.

*DISCUSSION ABOUT ALL THIS ON dev@hbase*
Yep, I'll launch a discussion as recommended very soon!

> maven archetype: client application
> -----------------------------------
>
>                 Key: HBASE-14877
>                 URL: https://issues.apache.org/jira/browse/HBASE-14877
>             Project: HBase
>          Issue Type: Sub-task
>          Components: build, Usability
>    Affects Versions: 2.0.0
>            Reporter: Nick Dimiduk
>            Assignee: Daniel Vimont
>              Labels: archetype, beginner, maven
>         Attachments: HBASE-14877-v2.patch, HBASE-14877-v3.patch, HBASE-14877-v4.patch,
HBASE-14877.patch
>
>




--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message