Uploaded image for project: 'CDH (READ-ONLY)'
  1. CDH (READ-ONLY)
  2. DISTRO-236

Build and publish "xref" docs for CDH

          Details

          • Type: Task
          • Status: Open
          • Priority: Minor
          • Resolution: Unresolved
          • Affects Version/s: CDH3u2
          • Fix Version/s: None
          • Component/s: Docs, Packaging
          • Labels:
            None

            Description

            The HBase folks run "xref" on their project, which produces pages like http://hbase.apache.org/xref/org/apache/hadoop/hbase/client/Delete.html . It's quite nice: it makes their code indexable by Google, and, since it understands Java, it's easy to move around between classes.

            You have considered doing a similar thing for the relevant bits of CDH? I suspect that the way the HBase folks do it is by running "mvn org.apache.maven.plugins:maven-jxr-plugin:2.2:jxr" in their build. This means that this would be easier for Maven-based projects, but I'm sure it's still quite doable for the ant-based ones if we figure out how maven-jxr-plugin actually works.

              Attachments

                Activity

                  People

                  • Assignee:
                    andrew Andrew Bayer
                    Reporter:
                    philip Philip Zeyliger
                  • Votes:
                    0 Vote for this issue
                    Watchers:
                    0 Start watching this issue

                    Dates

                    • Created:
                      Updated: