hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Busbey (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-14877) maven archetype: client application
Date Tue, 26 Jan 2016 17:27:39 GMT

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

Sean Busbey commented on HBASE-14877:

actual review feedback below ;) 

The README is a very nice touch! You should update the ref guide's section on building and
developing HBase to add a note that folks should seek out that file when working on the archetypes.
I went back and forth on if this text needs to all be in the ref guide, since folks are likely
to miss a README in a subdirectory. But I think the current ref guide is too confused in its
audience for that to work. Since we're committing to how some maintenance will work in the
future, it's worth you starting a thread on dev@hbase that directs folks attention to this
ticket and specifically the README. Make sure hte thread has a subject line that starts with
"[DISCUSS]", e.g. "[DISCUSS] new build tooling for creation of hbase application maven archetypes."

Similar to the above, I don't see any updates to the ref guide section on developing applications
to instruct folks on using the archetypes we provide. Maybe a follow on ticket added as another
subtask to the parent jira?

The README needs to have a file header so that we're in compliance [with ASF policy|http://www.apache.org/legal/src-headers.html].
You can see examples of the needed text in other files in the repo. It would probably be easiest
(and most readable) if you changed from a plain text file to a markdown file so that you can
make the header metadata.

* example rendered README: https://github.com/apache/hbase/blob/master/dev-support/hbase_docker/README.md
* raw version showing the header: https://raw.githubusercontent.com/apache/hbase/master/dev-support/hbase_docker/README.md

> 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,

This message was sent by Atlassian JIRA

View raw message