...
It is good practice to put a doc comment on the JIRA that you're documenting, with a link to the doc, so people watching that JIRA can review the doc changes and future JIRA trawlers can find the docs easily. See How to contribute section below.
One more thing: please remember to include Hive version information with your changes, because the wiki covers all releases of Hive. You can mention the version in the text or use a Version info box ("+" icon drop-down list, "Info" fifth from the bottom, enter "Version" or "Version information" as the title).
...
- To obtain export permission, send a request to user@hive.apache.org requesting export access and give your Confluence username (see How to get permission to edit above).
- To export the entire Hive wiki or selected pages, use Space Tools (left side of any wiki page) and select Content Tools (top bar in Space Tools) then select the Export tab. Choose an export format and click Next. Select Full Export or Custom Export, and click Export. For a custom export, you can choose which pages you want to export.
- To export the current wiki page, use the Tools drop-down list (upper right corner of any page) and select Export to PDF, Export to EPUB, or Export to Word.
How to find documentation tasks
Documentation tasks are tracked in JIRA using the TODOC label with version appended, eg TODOC2.0, TODOC1.3).
The following can quickly locate items potentially requiring further documentation:
- Browse to JIRA
- Select Issues - Search for Issues
- Select Project - Hive
- Select More.. Label TODOC
- Save Filter As
Another option is to search for string "Doc note:"
When the documentation has been completed and verified, the TODOC label can be removed from the issue.