Improve Project Links documentation

XMLWordPrintable

      We have a few documents talking about Project Links, and I'd like to suggest some changes to them, in order to explain in more details the current benefits you get for having a Project Link created. I though about this suggestion as I think there are some observed benefits which are not listed, or not completely listed in these documents. I'll refer to these documents as follows, so it's easier to reference them in my description:

      I'll enumerate the things I observed, so it's also easier to refer to them and where I observed them or not in these docs:

      1. The Project Link between a JIRA project and a FishEye repository and/or a Crucible project restricts the scope of the Activity Stream in JIRA, i.e. if I link my JIRA project to my FishEye repository, then creates an Activity Stream specifically for this JIRA project it will only display commits from the linked FishEye project, whereas if no FishEye repository is linked, the Activity Stream is going to show information from any FishEye repository.
      2. A link between a JIRA project and a Crucible project will make with, when a user creates a review for a commit in FishEye from the JIRA issue, the popup to select the Crucible project in which the review will be created comes already filled with the linked Crucible project. This is actually a convenience for some users, so they don't have to select the Crucible project every time.

      Below I'm describing which of the above I see in each of these docs or not:

      • The AppLinks Project Links doc has a brief example of the benefit 1, describing an example between JIRA and Confluence. Benefit 2 isn't mentioned. I thought it would be good to let clear to the customers they could also achieve both benefits, but I understand this specific page may not be intended to enter in many details about each of the apps, as it is a general doc for AppLinks, so maybe this information should be left to the pages specific to each product.
      • The FishEye Project Links doc mentions, under the Project links section, what seems to be a summary of the benefit 1, but I think it's not very clear on how the user can achieve it.
      • The Crucible Project Links doc doesn't mention benefit 2 at all, so I think it could be included.
      • I also noticed neither of the FishEye or Crucible Project Links docs are linked to the AppLinks Project Links doc, so I think it would make sense if they were linked (i.e. if the AppLinks Project Links doc offer links to the other two docs).

      Please let me know if any further detail is needed.

              Assignee:
              Unassigned
              Reporter:
              Gustavo Refosco (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: