...
- if you spot a broken link within the wikwiki, 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 itthem
We're working on restoring the attachments from the MoinMoin wiki and re-linking them.
...
- Create a Confluence account if you don't already have one.
- Sign up for the user mailing list by sending a message to user-subscribe@hive.apache.org.
- Send a message to user@hive.apache.org requesting write access to the Hive wiki, and provide your Confluence username.
How to edit the Hive wiki
Anchor | ||||
---|---|---|---|---|
|
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; but auto-save does not notify watchers. 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 issue that you're documenting, with a link to the doc, so people watching that JIRA issue can review the doc changes and future JIRA trawlers can find the docs easily. See See How to find documentation tasks below.One more thing: please remember to
Info | ||
---|---|---|
| ||
Please include Hive version information with your changes, because the wiki covers all releases of Hive. |
...
You can |
...
give the version either in the text or |
...
in a Version info box like this one (click the "+" icon |
...
, select "Info" |
...
from the |
...
drop-down list, enter "Version" or "Version information" as the title). To link to a JIRA issue, highlight some text or the issue ID such as HIVE-10000 and click the link icon (upper middle-right side of the page), using the "Web link" option on the left side of the "Insert link" window. |
Links to other parts of the wiki should be made with the "Advanced", "Search", or "Recently viewed" option of the "Insert link" window rather than using the "Web link" option, so that Confluence can automatically adjust links to any sections that get renamed.
If you rename a section and want to preserve external links to it, you should add an anchor for the old title in a text paragraph before or after the changed heading. (Do not put the anchor on the heading itself because that affects internal links.) Anchors can also be used for links to text or graphics within a section. To insert an anchor, use the "+" icon and select "Other macros" at the bottom of the drop-down list. For an example, look at this section in Edit mode.
Advanced Links
For "Advanced" links within the wiki, the Link field is case-sensitive. An advanced link to a Hive wiki page just uses the title as shown at the top of that page, which may or may not include spaces:
Sections within a wiki page are marked with a "#" sign. Subheadings are treated the same as major headings:
An advanced link to a section on the same wiki page only needs "#" and the heading text in the Link field:
Links to anchors work the same as sections:
How to export the Hive wiki
...