This page last changed on Aug 20, 2009 by rosie@atlassian.com.
On this page:
Why would I set up local online documentation?
You may wish to run the documentation locally, and have JIRA link to it. There are a few reasons you may wish to do this:
- JIRA's interface contains links (
) to help pages, some to pages within JIRA, but many to the online documentation on www.atlassian.com. For deployments in environments without an internet connection, a local copy of the documentation is desirable.
- If you have customised JIRA, you may wish to update the documentation to reflect your changes, or add new pages.
- You can change the look and feel of the documentation to integrate into your company's intranet.
How to set up local online documentation
For JIRA 4.0.x and later:
- Install Atlassian Confluence. (If you don't already have Confluence, ask for a free Evaluation License. You can use 'Anonymous' access to allow your users to view the documentation.)
- Download the JIRA Documentation's XML source. Note that the Confluence version of the XML source needs to be the same major Confluence version as your local Confluence site.
- Import the XML file into your Confluence site. (Note: if there is already a 'JIRA' space in your Confluence site, it will be overwritten.) For detailed instructions, see the Confluence documentation on Restoring a Space.
- (Optional) If you want JIRA's help links (
) to point to your local documentation, you will need to:
- edit JIRA's /WEB-INF/classes/help-paths.properties file and change the url-prefix line so that it points to the 'JIRA' space in your local Confluence site, e.g.:
url-prefix=http://confluence.mycompany.com/display/JIRA/
- restart JIRA.
For JIRA 3.13.x and earlier:
JIRA licensees can download the XML source for the documentation.
To build JIRA's docs locally:
- Download Apache Forrest 0.5.1 (zip, tar.gz), used to render the docs.
- Download the JIRA Documentation's XML source (6.2Mb). Note: the download is restricted to JIRA license holders.
- Follow the JIRA_DOCUMENTATION.txt instructions in the package.
Local field documentation
If you just want to document usage of a custom field, please see Creating Help for a Custom Field.
|