Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-14876 Provide maven archetypes
  3. HBASE-15176

maven archetype: add end-user-oriented documentation to book.html

    Details

    • Type: Sub-task
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 2.0.0
    • Fix Version/s: None
    • Component/s: documentation
    • Labels:
      None

      Description

      Misty Stanley-Jones advises (from HBASE-14877):
      Please add a section to http://hbase.apache.org/book.html#hbase_apis, before the Examples section, with a brief (one-paragraph?) explanation of Maven archetypes and how the HBase archetypes can help developers get started quickly... The source for that chapter is in src/main/asciidoc/_chapters/hbase_apis.adoc.

        Activity

        Hide
        daniel_vimont Daniel Vimont added a comment -

        Completion of the task outlined here awaits resolution of this issue: HBASE-17598

        Once that issue is dealt with (which would make the archetypes publicly available via the Maven Central Repository), we can add some straightforward documentation to the HBase Reference Guide. A good model to follow might be the "quickstart" guide in the Apache Beam project, which makes excellent use of an archetype to get Beam newbies up and running in a matter of minutes: https://beam.apache.org/get-started/quickstart-java/

        Show
        daniel_vimont Daniel Vimont added a comment - Completion of the task outlined here awaits resolution of this issue: HBASE-17598 Once that issue is dealt with (which would make the archetypes publicly available via the Maven Central Repository), we can add some straightforward documentation to the HBase Reference Guide. A good model to follow might be the "quickstart" guide in the Apache Beam project, which makes excellent use of an archetype to get Beam newbies up and running in a matter of minutes: https://beam.apache.org/get-started/quickstart-java/

          People

          • Assignee:
            daniel_vimont Daniel Vimont
            Reporter:
            daniel_vimont Daniel Vimont
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:

              Development