Appendix A. Contributing to Documentation

Table of Contents

A.1. Getting Access to the Wiki
A.2. Contributing to Documentation or Other Strings
A.3. Editing the HBase Website
A.4. Editing the HBase Reference Guide
A.5. Auto-Generated Content
A.6. Multi-Page and Single-Page Output
A.7. Images in the HBase Reference Guide
A.8. Adding a New Chapter to the HBase Reference Guide
A.9. Docbook Common Issues

The Apache HBase project welcomes contributions to all aspects of the project, including the documentation. In HBase, documentation includes the following areas, and probably some others:

No matter which area you want to help out with, the first step is almost always to download (typically by cloning the Git repository) and familiarize yourself with the HBase source code. The only exception in the list above is the HBase Wiki, which is edited online. For information on downloading and building the source, see Chapter 18, Building and Developing Apache HBase.

A.1. Getting Access to the Wiki

The HBase Wiki is not well-maintained and much of its content has been moved into the HBase Reference Guide (this guide). However, some pages on the Wiki are well maintained, and it would be great to have some volunteers willing to help out with the Wiki. To request access to the Wiki, register a new account at https://wiki.apache.org/hadoop/Hbase?action=newaccount. Contact one of the HBase committers, who can either give you access or refer you to someone who can.

comments powered by Disqus