Versions Compared

Old Version 23

changes.mady.by.user Lefty Leverenz

Saved on

compared with

New Version 24

changes.mady.by.user Lefty Leverenz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edit "How to edit"

...

Anchor
How to edit
How to edit
Once you have wiki edit privilege and are logged in, an Edit button will appear in the upper right corner of each wiki document (next to Watch and Share). 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 docdocument. 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 page 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 Tools drop-down list ("..." button) 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 docwiki page, so people watching that issue can review the doc your changes and future JIRA trawlers can find the docs documentation easily. See How to find documentation tasks below for more about the JIRA.

Info
titleVersion information

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, and 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 Insert link icon (upper middle-right side of the page), using the "Web link" option on the left side of the "Insert link" window.

...

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

...