AttentionSet | Aviator Documentation

Inspired by Gerrit , AttentionSet is a dashboard for developers to track Pull Request reviews from GitHub. It is intended to track the code reviews back-and-forth between the author and the reviewers. Using AttentionSet, developers can easily unblock changes that are waiting on their action. AttentionSet dashboard Attention The dashboard identifies who should be paying attention to a PR. For instance, when the author prepares a PR and sends it to the reviewers, the reviewers have the attention; and when the reviewers respond back to the PR (commenting or approving), the author gets the attention back. The dashboard also displays the reason why an attention is assigned to you or who is your PR’s attention assigned to. Every PR can have one or more people who have the attention, a PR may also occasionally have no attention, although this should be rare for a PR that is in open / ready for review state. A merged PR will not have anyone’s attention. Attention is typically managed automatically, but it can also be toggled manually as needed. Getting started If you are a new Aviator user, you will first need to install the Aviator app on your GitHub repository. This is typically done as part of the initial setup wizard. You can choose to start with any of MergeQueue or FlexReview workflows to begin the setup. Aviator setup wizard Once the initial setup is complete, you will be prompted to link the GitHub account. This step is necessary so we verify your GitHub username that is used to track your attention. AttentionSet - Link GitHub account Previous Introduction Next AttentionSet Best Practices Last updated 1 year ago Was this helpful?

The technical content provided is mostly clear, but there are a few areas where improvements or clarifications could be made:

1. Grammar and Clarity:

   • "AttentionSet is a dashboard for developers to track Pull Request reviews from GitHub." could be rephrased for clarity. Consider: "AttentionSet is a dashboard designed for developers to track Pull Request reviews on GitHub."
   • "The dashboard also displays the reason why an attention is assigned to you or who is your PR’s attention assigned to." could be clearer. Consider: "The dashboard also displays the reason why attention is assigned to you or to whom your PR's attention is assigned."

2. Consistency:

   • The term "attention" is used in various forms (e.g., "an attention," "the attention"). It might be clearer to consistently use "attention" as a non-count noun, e.g., "who has attention on a PR."

3. Technical Details:

   • The phrase "Aviator setup wizard" is mentioned without context. It might be helpful to clarify that this is a part of the setup process for new users.
   • The sentence "You can choose to start with any of MergeQueue or FlexReview workflows to begin the setup." could be clearer. Consider: "You can choose to start with either the MergeQueue or FlexReview workflow to begin the setup."

4. Linking GitHub Account:

   • The phrase "This step is necessary so we verify your GitHub username that is used to track your attention." could be clearer. Consider: "This step is necessary to verify your GitHub username, which is used to track your attention."

5. Visual Elements:

   • The headings "AttentionSet dashboard," "Attention," "Getting started," "Aviator setup wizard," and "AttentionSet - Link GitHub account" suggest there might be visual elements or sections in the original document. Ensure these are formatted correctly in the actual documentation to distinguish them as headings or sections.

Overall, the content is technically sound, but these adjustments could enhance clarity and readability.

No product messaging analysis available for this page.

No competitive analysis available for this page.