You can include images in the HBase Reference Guide. For accessibility reasons, it is recommended that you use a <figure> Docbook element for an image. This allows screen readers to navigate to the image and also provides alternative text for the image. The following is an example of a <figure> element.

<figure>
  <title>HFile Version 1</title>
  <mediaobject>
    <imageobject>
      <imagedata fileref="timeline_consistency.png" />
    </imageobject>
    <textobject>
      <phrase>HFile Version 1</phrase>
    </textobject>
  </mediaobject>
</figure>
        

The <textobject> can contain a few sentences describing the image, rather than simply reiterating the title. You can optionally specify alignment and size options in the <imagedata> element.

When doing a local build, save the image to the src/main/site/resources/images/ directory. In the <imagedata> element, refer to the image as above, with no directory component. The image will be copied to the appropriate target location during the build of the output.

When you submit a patch which includes adding an image to the HBase Reference Guide, attach the image to the JIRA. If the committer asks where the image should be committed, it should go into the above directory.