Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-20084

Hard-coded help links in Admin Console screens should use the new configurable linking design

    XMLWordPrintable

Details

    Description

      1) Administration Console front screen - daily backups
      In the Confluence Administration Console is a screen called "Administration Console". This is the first screen you see when you select "Browse" -> "Confluence Admin".
      (Local URL is http://localhost:8080/admin/console.action.)

      On that screen is a section warning people about daily backups. In that section is some hyperlinked text:

      Instead, we recommend that you perform a manual backup of your Confluence database, home directory and attachments. For more information, please refer to our online documentation.

      Currently, the help link on the words "our online documentation" is hard-coded to the following URL:
      http://confluence.atlassian.com/x/_n4C

      Instead, it should use the new configurable and release-dependent design for help links, as described in CONF-11416. The page name to link to is: "Site+Backup+and+Restore".

      2) Administration Console front screen - evaluation database (HSQL)
      In the Confluence Administration Console is a screen called "Administration Console". This is the first screen you see when you select "Browse" -> "Confluence Admin".
      (Local URL is http://localhost:8080/admin/console.action.)

      There is a section at the bottom warning people about the evaluation database (HSQL).

      In that section is some hyperlinked text:

      Please refer to our online documentation for supported database configurations.

      Currently, the help link on the words "our online documentation" is broken.

      It should use the new configurable and release-dependent design for help links, as described in CONF-11416. The page name to link to is: "Supported+Platforms".

      3) Daily Backup Administration - evaluation database (HSQL)
      The same problem mentioned in point 2 above also occurs on the screen called "Daily Backup Administration".
      (Local URL is http://localhost:8080/admin/dailybackupadmin.action.)

      Note: The section in the "Help Tips" is OK but the yellow warning box is not.

      4) General configuration screen - remote API
      In the Confluence Administration Console is a screen called "General Configuration ".
      (Local URL is http://localhost:8080/admin/viewgeneralconfig.action.)

      On the right of that screen is a section called "Help Tips". In that section is some hyperlinked text:

      More about Remote APIs

      Currently, the help link on the above words is broken. It cannot use the standard new linking design, because it has to link to the CONFDEV space rather than the DOC space. So we will need to use a permlink.

      The page to link to is:
      http://confluence.atlassian.com/x/3QI

      5) Plugin Manager
      In the Confluence Administration Console is a screen called "Plugin Manager".
      (Local URL is http://localhost:8080/admin/viewplugins.action.)

      On the right of that screen is a section called "Help Tips". In that section is some hyperlinked text:

      More about plugins

      Currently, the help link on the above words is broken. It is using the new help link design, which is good. But it is pointing to the wrong page. The page name to link to is: "Installing+Plugins+and+Macros".

      6) User Macros
      In the Confluence Administration Console is a screen called "User Macros".
      (Local URL is http://localhost:8080/admin/usermacros.action.)

      On the right of that screen is a section called "Help Tips". In that section is some hyperlinked text:

      More about user macros

      Currently, the help link on the above words is broken. It is using the new help link design, which is good. But it is pointing to the wrong page. The page name to link to is:
      "Adding%2C+Editing+and+Removing+User+Macros"

      7) WebDAV Configuration
      In the Confluence Administration Console is a screen called "WebDAV Configuration".
      (Local URL is http://localhost:8080/admin/plugins/webdav/config.action.)

      On that screen is a section called "Disable Strict Path Checking". In that section is some hyperlinked text:

      ...fix it by rebuilding the ancestor table.

      Currently, the help link on the words "rebuilding the ancestor table" is hard-coded to the following URL:
      http://confluence.atlassian.com/display/DOC/Rebuilding+the+Ancestor+Table

      Instead, it should use the new configurable and release-dependent design for help links, as described in CONF-11416. The page name to link to is: "Rebuilding+the+Ancestor+Table".

      8) Generate Thread Dumps
      In the Confluence Administration Console is a screen called "Generate Thread Dumps".
      (Local URL is http://localhost:8080/admin/threaddump.action.)

      Near the top of the screen is some hyperlinked text:

      Please refer to the documentation for...

      Currently, the help link on the word "documentation" is hard-coded to the following URL:
      http://confluence.atlassian.com/display/DOC/Generating+a+Thread+Dump

      Instead, it should use the new configurable and release-dependent design for help links, as described in CONF-11416. The page name to link to is: "Generating+a+Thread+Dump".

      Attachments

        Issue Links

          Activity

            People

              shaffenden Steve Haffenden (Inactive)
              smaddox SarahA
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: