History

The Apache Hive wiki originally started out as a subspace in the Apache Hadoop MoinMoin wiki (when Hive was still a Hadoop subproject). When Hive graduated to become a top-level project, we moved its wiki out to a top-level Confluence wiki. (The MoinMoin wiki has been under attack by spammers, captchas weren't helping, and there didn't seem to be a way to use access control to defend the Hive subspace.)

Just like in a real move, sometimes stuff gets broken in transit. The MoinMoin and Confluence markup languages are somewhat different, and the migration tools we used didn't preserve everything perfectly. We've been manually fixing things up as we get time. You can help! In order to edit the wiki, you'll first need to create yourself an account, and then you can post on the Hive users mailing list requesting write access.

Some things that need fixing:

  • if you spot a broken link within the wik, look for the page name in this list and fix the link
  • if you spot a link to the old wiki in some other site, please update it to point directly to the correct location in the new wiki
  • if you see bad markup (usually highlighted in red), fix it; Confluence markup syntax is the same as JIRA since they come from the same company
  • if you see spam links left over from the MoinMoin days, remove it

We're working on restoring the attachments from the MoinMoin wiki and re-linking them.

To prevent further edits on the MoinMoin source, we've deleted all the pages there (replacing them with instructions for how to find their new locations), but we have a full backup of the MoinMoin data in case we notice that anything was entirely lost in the move.

How to get permission to edit

How to edit

Once you have wiki edit privilege, an Edit button will appear in the upper right corner of each wiki document (next to Share and Tools). That takes you to the Edit window, where you should enter a brief note about the nature of your changes in a field at the bottom ("What did you change?") and then edit the doc.  A bar across the top has fairly obvious GUI symbols and there's help via the "?" button, top right.

In the bottom right corner there's a Preview button (which toggles with Edit) and a Save button. The editor auto-saves and keeps your draft, which you can find in the drop-down list on your ID picture (upper right). When you use the Save button, email gets sent to everyone watching that wiki document unless you've unchecked "Notify watchers" at the bottom. If you save something and then decide it's all wrong, you can go to the page history and revert it. Page history is in the Tools drop-down list on every wiki page (but not in the editing window).

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).

How to export the Hive wiki

The Hive wiki can be exported to HTML, XML, or PDF. Individual pages can be exported to PDF, EPUB, or Word.

  • 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:

  1. Browse to JIRA
  2. Select Issues - Search for Issues
  3. Select Project - Hive
  4. Select More.. Label TODOC
  5. 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.




  • No labels