Page History

...

XML Source Conventions

Frequently Used Tags

The essential tags for documenting programming-type information are similar to the tags found in HTML. For example:

  <p>

      A paragraph with some text.

  </>

  <ul>

    <li>Unordered list item.</li>

  </ul>

  <ol>

    <li>Ordered list item.</li>

  </ol>

<codeblock>

Sample code and/or output.

Spacing is preserved in output, so don't add extra indentation.

Left-justify the codeblock start and end tags.

</codeblock>

Internal and External Links

...

By convention, to allow for filtering in JIRA reports and email notifications, commits that are purely for documentation updates include the eyecatcher string DOCS inside square brackets. (Literal example with square brackets omitted for the moment because Confluence wants to turn it into a link.) )

Often, an IMPALA- JIRA for a new feature or improvement has a subtask (with its own JIRA number) for documenting the new feature or the behavior changes. When including a JIRA number in the subject line of the commit message, prefer to use the JIRA number for the parent issue rather than the one for the doc-specific subtask.

gerrit Reviews