Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-21477

Guide to creating your own local docs should mention the Documentation theme and its inclusions

    XMLWordPrintable

Details

    • We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

    Description

      The JIRA docs have a great guide telling people how to get their own local version of the JIRA docs:
      http://confluence.atlassian.com/display/JIRA/Local+JIRA+documentation

      In the section on using the XML export files from CAC (JIRA 4.0 and later), we should mention the fact that our CAC docs use the Documentation theme.
      (Point them to the guide to the doc theme:
      http://confluence.atlassian.com/display/JIRA/Local+JIRA+documentation)

      Also mention that by default, when you import a space from XML, it will be loaded with the Documentation theme as the space theme. (Sarah has tested this on Thurs 3 June using Confluence 3.2.1.)

      Also, their space will inherit our customised header, footer and left-hand navigation bar.

      Due to the fact that we use these locations to link to earlier versions of the docs, and to provide the copyright notice etc, they will find that their own space has some broken links and broken include statements.

      See attached screenshot – this is what my new space looks like immediately after importing from XML.

      The fix is to customise the header, footer and left-hand nav to suit their own environment, or simply to remove all content from the header, footer and left-hand nav bar and to reselect the "page tree" checkbox. See
      http://confluence.atlassian.com/display/DOC/Configuring+the+Documentation+Theme

      Alternatively, they can choose a different theme.

      Attachments

        Activity

          People

            wthompson Wazza
            smaddox SarahA
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: