-
Type:
Suggestion
-
Resolution: Duplicate
-
Component/s: Documentation, Server administration, User interface
-
None
Change the URLs on the FishEye Admin screens to point to the new doc pages on CAC.
- Use permanent URLs (i.e. perm links, not links based on page names, which may change).
- Implement a single file containing the help links (as is done for JIRA) - better for maintainability and versioning.
- Maybe we can host the help-links file on Atlassian servers by default, instead of shipping it with the product? So the code would have to say something like:
- Look for my help-links file locally.
- If not found, look for my help-links file on Atlassian servers.
- Having found my help-links file, look to see if there is a help link for my field (e.g. by field ID).
- If no help link found, do not display help icon.
- If help link found, collect the corresponding URL and display the help icon.
This way, we can dynamically add the help links as we build the documentation pages. And we can also allow our customers to supply their own help-links file e.g. if they have downloaded our docs and installed the docs on their own Confluence server (e.g. within a firewall).
NOTE: At each major product release (1.1, 1.2, etc), the doc space on CAC is archived. The online help links will need to take the archiving process into account, because URLs will change.