Confluence help links should point to the appropriate version of the docs

XMLWordPrintable

      Important for

      • Release management — documentation matches Confluence version.
      • Internationalisation support in the docs (CONF-10758).
      • Customers using offline versions of our documentation.

      We need two mechanisms:
      1) Control of page-level destinations: Externalise the link paths, so that partners, customers and tech writers can control the destination (at page level) of each help link.
      2) Release management: The Confluence documentation applies to a specific release of Confluence. The DOC space is always for the latest release. Other archive spaces apply to specific previous releases e.g. CONF27, CONF26, etc. The help links need to be redirected to the correct version-specific space.

      Suggested solutions — applied to our other products:

      • Solution for (1) above is a help-paths.properties file shipped with the product. Already in use for JIRA, Crowd, FishEye, Crucible
      • Solution for (2) above is some sort of redirect mechanism, as we have already done for Crowd and FishEye — use a .htaccess file on the docs.atlassian.com server.

      See blog post: http://blogs.atlassian.com/news/2007/12/using_a_wiki_fo.html

      The release management is becoming more and more important as the look and feel of Confluence changes. See attached screenshot showing the sort of problem people are having.

            Assignee:
            Gerry Claps
            Reporter:
            SarahA
            Votes:
            9 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: