Uploaded image for project: 'Apache Blur'
  1. Apache Blur
  2. BLUR-440

Add "Getting Started" guide for new/would-be developers

    XMLWordPrintableJSON

Details

    • Task
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • None
    • None
    • Blur
    • None

    Description

      Blur has grown into quite a large code base and can be intimidating to begin hacking on. I think it'd help the community to have a guide for new developers wanting to understand Blur from building it, where to begin code reading, etc. If folks can chip in a tip or two of what challenges they faced when first getting started, we can come up with something really handy.

      Something along the lines of:

      o Building o
      git clone...
      mvn eclipse:eclipse -Dhadoop2

      o Components Overview o
      blur-thrift does ...
      blur-core does...

      o Code Reading o
      A nice way to begin understanding Blur is by looking at the thrift interface Blur.Iface[1]. Reviewing that API and the corresponding code in blur-core's thrift package[2] is a good way to start. Read through the more 'admin' methods (e.g. tableStats) first...

      [1] - http://incubator.apache.org/blur/docs/0.2.3/site/apidocs/org/apache/blur/thrift/generated/Blur.Iface.html
      [2] - https://github.com/apache/incubator-blur/tree/master/blur-core/src/main/java/org/apache/blur/thrift

      Attachments

        Activity

          People

            Unassigned Unassigned
            williamstw Tim Williams
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated: