THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
This is a page to record processes and procedures related to documentation, especially tips for developers who would like to contribute to the documentation.
Historically, the Impala documentation has lived on the Cloudera web site; however, the entire rendered Impala documentation set is now available on the Documentation tab of the Apache Impala (incubating) web site. The rendered documentation is available in HTML and PDF. These links include all of the currently available Impala documentation: the release notes, SQL reference, installation, administration, and development guides.
Authoring Logistics
Source of the main Impala documentation (SQL Reference and such) is in XML, using the DITA XML format and buildable by an open source toolchain.
Version control is through git. The doc source files live underneath the docs/ subdirectory, in the same repository as the Impala code.
XML Source Conventions
Frequently Used Tags
Internal and External Links
Reuse via conref= Attribute
XML Validation
Commit Messages
gerrit Reviews