Details
-
Suggestion
-
Resolution: Fixed
-
None
Description
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.
Attachments
Issue Links
- causes
-
CONFSERVER-20235 Hard-coded links to localhost remaining in Confluence 3.3
- Closed
-
CONFSERVER-20234 Hard-coded links to CAC remaining in Confluence 3.3
- Closed
-
CONFSERVER-20242 Demo Space: There are several hard-coded links to CAC included in the Demo space content
- Closed
-
CONFSERVER-20243 Confluence help-paths.properties file should be in WEB-INF/classes and not in a JAR
- Closed
- relates to
-
CONFSERVER-20070 Hard-coded help link on PDF Layout screen should use the new configurable linking design
- Closed
-
CONFSERVER-20084 Hard-coded help links in Admin Console screens should use the new configurable linking design
- Closed
-
CONFSERVER-20086 Hard-coded help links in Dashboard welcome message should use the new configurable linking design
- Closed
-
CONFSERVER-20087 Hard-coded help links in various user actions should use the new configurable linking design
- Closed