Uploaded image for project: 'Automation for Cloud'
  1. Automation for Cloud
  2. AUTO-197

Show inline / in-product documentation for Automation, contextual help, esp. for smart values

    XMLWordPrintable

Details

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      This will allow us to show better and more relevant docs

      Smart values are super powerful but the syntax isn't always the easiest. At the very least we should try to link to the smart value documentation https://support.atlassian.com/jira-software-cloud/docs/smart-values-general/ from our components until a smart value auto-complete is available

      Specific examples

      • Provide some better in-product guidance around field value changed trigger - Need to explain better that this is an issue event based trigger applying to created, edited, transitioned or assigned.
      • The Branch automation rules to perform actions on related issues documentation does not mention that the Issues in the sprint relation type only works with sprint created, started or completed triggers.
      • Mention in the Jira Automation documentation how exactly permissions work (lookup issues) - Since by default Jira Automation executes rules using the Automation for Jira user, and the user has permissions on all the projects, some actions could not be restricted to who is creating the rule. For example, the lookup issues action could show information that is not allowed to see since the JQL query is executed with the Automation for Jira user
      • Improve Automation for Jira Documentation for issue.[Custom Field] Available properties - The Smart values - general product document says, issue.[Custom Field].name returns the visible label displayed on the left of the field.

      However, using this property on a custom field doesn't return the name of the custom field.

      Please update the documentation to include this information.

      Attachments

        Issue Links

          Activity

            People

              b5485955f50a Michael Fedulov
              89403358cf11 Charlie Gavey
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: