GitBook: [#33] No subject

SUMMARY.md

@@ -31,4 +31,9 @@
   * [Getting started with the dashboard](guides/graphite-dashboard/getting-started-with-the-dashboard.md)
   * [Using the review queue](guides/graphite-dashboard/using-the-review-queue.md)
   * [Customizing the review queue](guides/graphite-dashboard/customizing-the-review-queue.md)
-  * [Reviewing code with Graphite \[alpha\]](guides/graphite-dashboard/reviewing-code-with-graphite-alpha.md)
+  * [Updating your pull requests](guides/graphite-dashboard/reviewing-code-with-graphite-alpha.md)
+  * [Reviewing pull requests](guides/graphite-dashboard/reviewing-pull-requests.md)
+  * [Merging your pull requests](guides/graphite-dashboard/merging-your-pull-requests.md)
+  * [Team insights \[alpha\]](guides/graphite-dashboard/team-insights-alpha.md)
+  * [Feature requests & bugs](guides/graphite-dashboard/feature-requests-and-bugs.md)
+  * [Share Graphite with your team](guides/graphite-dashboard/share-graphite-with-your-team.md)

guides/graphite-dashboard/README.md

@@ -6,6 +6,6 @@ Along with the CLI, Graphite includes a [**web dashboard**](https://app.graphite
 
 Get started with the Graphite dashboard:
 
-{% content-ref url="broken-reference" %}
-[Broken link](broken-reference)
+{% content-ref url="getting-started-with-the-dashboard.md" %}
+[getting-started-with-the-dashboard.md](getting-started-with-the-dashboard.md)
 {% endcontent-ref %}

guides/graphite-dashboard/customizing-the-review-queue.md

@@ -4,7 +4,7 @@
 
 If you want to customize a section, click the ⚙️ icon in the upper right of the section to open the section editing modal:
 
-![](<../../.gitbook/assets/Screen Shot 2021-10-14 at 7.58.11 PM.png>)
+![Quickly customize your filters and re-arrange your dashboard sections ](../../.gitbook/assets/customize\_pr\_inboxes.gif)
 
 From this modal, you can update the section name, repositories, and filters, choose whether to include PRs in the section on the favicon badge count, and delete the section.
 

guides/graphite-dashboard/feature-requests-and-bugs.md

@@ -0,0 +1,13 @@
+# Feature requests & bugs
+
+As a Graphite beta user, your feature requests & bug reports play a huge part in helping us improve the product experience. We made feedback a first-class feature in all of our product & community surfaces:
+
+* From the CLI, just run `gt feedback {your message}` to share with us
+* From the Graphite dashboard, click "Send feedback" in the lower left corner to send free-form feedback
+* From the Graphite dashboard, click "Feature requests & bugs" in the lower left corner to share a feature request or bug to be voted on by the Graphite community
+
+![](../../.gitbook/assets/feedback.gif)
+
+You can also always post your feedback or suggestions in the `#feature-requests` or `#bug-reports` channels in the Graphite Community Slack channel:
+
+{% embed url="https://join.slack.com/t/graphite-community/shared_invite/zt-v828g9dz-TIRvlutxTCqgZmxnsO9Knw" %}

guides/graphite-dashboard/merging-your-pull-requests.md

@@ -0,0 +1,29 @@
+# Merging your pull requests
+
+## Merging a single PR
+
+Once your PR has been approved & is passing CI (+ any other checks/merge protections you've enabled in GitHub), you'll be able to merge it from Graphite.  Merging a single PR is easy - just hit "Merge" on the right side of the PR title bar.
+
+![Click "Merge" to merge a PR from Graphite - you can also use the dropdown to choose a different merge strategy](../../.gitbook/assets/merge.gif)
+
+You can use the dropdown on the `Merge` button to select a different merge strategy (Graphite will pull in your default merge strategy from GitHub).  Once your PR has been merged, you'll see a confirmation snackbar in the bottom left corner of the screen.
+
+{% hint style="info" %}
+If you're using the Graphite CLI, you'll want to make sure to run `gt repo sync` immediately after merging in a change to your remote trunk branch - this ensures that your local environment is up-to-date and ready for you to keep developing!
+{% endhint %}
+
+## Merging a stack of PRs
+
+When you view a PR that is part of a stack (and not the bottom-most PR in that stack), instead of the `Merge` button you'll see `Merge all (n)`, where "n" is the number of PRs below the current PR in the stack + the current PR.  `Merge all (n)` lets you kick off a job to have Graphite merge every PR in the stack up thru the current PR into your trunk branch, starting from the bottom of the stack. 
+
+You can select a merge strategy for `Merge all (n)` to use, and it will run until it either completes the merges thru the PR you triggered it from, or until it hits a merge conflict or CI failure (at which point it will stop).
+
+`Merge all (n)` will also add a comment to the affected PRs in GitHub, so that your colleagues can see that those PRs are queued to be merged or are in the process of being merged:
+
+![](../../.gitbook/assets/merge\_all\_conflict\_github\_2.png)
+
+These statuses will similarly be displayed on the PR on the Graphite dashboard.
+
+{% hint style="info" %}
+If `Merge all (n)` fails due to a rebase conflict, go to your terminal and run `gt repo sync && gt stack fix && gt stack submit` (resolving any conflicts along the way and running `gt continue`).  Once you've done this, go back to the affected PR in Graphite (or to the same place in the stack where you initially kicked off the `Merge all (n)` job), and click `Merge all (n)` one more time to re-queue the PR for merging.
+{% endhint %}

guides/graphite-dashboard/reviewing-code-with-graphite-alpha.md

@@ -1,39 +1,9 @@
-# Reviewing code with Graphite \[alpha]
+# Updating your pull requests
 
-{% hint style="warning" %}
+{% hint style="info" %}
 We're rapidly iterating on our code review interface - expect frequent updates as we refine the experience!
 {% endhint %}
 
-If you're part of the **code review preview group**, clicking on a pull request in the review queue will open the Graphite pull request page instead of GitHub:
-
-![](<../../.gitbook/assets/Screen Shot 2021-10-15 at 4.29.25 PM.png>)
-
-## Key features
-
-#### For code authors:
-
-* Edit PR details (title, status, reviewers, description, labels etc)
-* View and reply to review comments
-* Merge PR
-
-#### For code reviewers:
-
-* Browse code changes & PR history
-* Navigate between all PRs in a stack
-* Add in-line and top-level comments
-* Submit a review
-
-## Coming soon
-
-* "Land all" - merge all PRs in a stack at once (if approved & mergable)
-* Memes & macros
-* Keyboard shortcuts & command bar
-* Highlight important changes
-* Suggested changes & splits
-* And much more...
-
-{% hint style="info" %}
-Want to try out Graphite code review?  Send us a message in Slack!
-{% endhint %}
+Clicking on a PR in the review queue will open in up in Graphite.  If you're the author of the PR, you'll be able to edit the title, status, reviewers, labels, and description directly from Graphite (any changes you make are synced to GitHub).  Here's what it looks like to update the reviewers on a PR:
 
-{% embed url="https://join.slack.com/t/graphite-community/shared_invite/zt-v828g9dz-TIRvlutxTCqgZmxnsO9Knw" %}
+![Updating the reviewers on a PR is faster than ever with Graphite's keyboard shortcuts - just type "E" then "R" to edit](../../.gitbook/assets/reviewer\_dropdown\_updates.gif)

guides/graphite-dashboard/reviewing-pull-requests.md

@@ -0,0 +1,67 @@
+# Reviewing pull requests
+
+{% hint style="info" %}
+When you click on a PR from a colleague in the review queue, you'll be able to view the proposed changes, add your comments, and submit your review from Graphite.
+{% endhint %}
+
+## Timeline, file tree, & Focus Mode
+
+By default, Graphite shows you a timeline of changes, comments, and reviews for a PR in a tray on the right side of the screen:
+
+* Clicking a comment which references a specific line of code will scroll that change into view
+* Clicking a commit currently takes you to GitHub, but will soon show the diff for that commit only in Graphite
+
+To show the file tree, click the 🗂 icon in the top right corner of the right-side tray.  The file tree shows you the subdirectories of all files changed in a PR:
+
+* Clicking on a changed file will scroll it into view
+* New and deleted filenames highlighted green & red respectively
+
+To enter Focus Mode and hide the right side tray altogether, just click the ⏭ icon in the top left of the timeline/file tree tray.  You can show it again by clicking the "⌄" icon on the PR title bar.
+
+{% hint style="info" %}
+You can quickly toggle Focus Mode (show/hide the right-side tray) on the PR page with the keyboard shortcut `C`.
+{% endhint %}
+
+## Adding comments
+
+To add a comment, highlight the lines you want to comment on (you can select one line or multiple lines of code on either side of the diff), enter your comment, and click `Save` (or use `CMD + Enter`).  Your comment is now pending - it will show up to you in GitHub as a pending comment, and you can go back and edit it as much as you like before you complete your review (using the review options on the PR title bar).
+
+{% hint style="warning" %}
+You need to click one of the review options ("Approve", "Request changes", or "Just add comments") on the PR title bar for pending comments to be shared with the author.
+{% endhint %}
+
+## Adding GIFs & memes to review comments
+
+One of the features we missed the most from Phabricator was the ability to quickly add GIFs & memes to our code reviews to keep them lighthearted and fun.  That's why we brought back first-class support for GIFs & memes in Graphite!
+
+![Find the perfect GIF for your review with Giphy, choose one from your team's meme library, or upload a new one](<../../.gitbook/assets/gifs\_and\_memes (1).gif>)
+
+Adding a GIF is easy with our Giphy integration:
+
+1. Click the `GIF` icon in the comment box
+2. Type in your search text and hit `Enter`
+3. Click on the GIF you want to add to your comment, and hit `Save` to see it rendered!
+
+Alternatively, you can select a GIF/meme from your team's meme library:
+
+1. Click the `#` icon in the comment box
+2. Click "Browse org macros"
+3. Type in your search text, or just click the GIF/meme you want to add to your comment
+4. Hit `Save` to see it rendered!
+
+{% hint style="info" %}
+Note that every GIF/meme in your team's meme library has a shortcode next to it, which you can use to quickly add it to a review comment with "/".  Try typing "/cathack" into a comment to see this in action!
+{% endhint %}
+
+Lastly, you can upload your own GIFs & memes to your team's meme library:
+
+* Click the `#` icon in the comment box
+* Click "Upload new macro"
+* Choose an image/GIF, give it a shortcode, and add it to your comment
+* Hit `Save` to see it rendered!
+
+## Reviewing stacked pull requests
+
+Graphite makes it easy to review large stacks of PRs at once. From your PR inbox, just click into a pull request to see the PR details, code changes, and comments. You can always see where the current PR sits and navigate to any of the other PRs in a stack with the "Show stack" button, or by using the keyboard shortcut `S`.  Starting from the bottom of the stack, just add your comments, choose your review outcome, and move on to the next PR in the stack!
+
+![Use the stack visualization modal to quickly navigate between PRs in a stack as you review](<../../.gitbook/assets/review\_stacks (1).gif>)

guides/graphite-dashboard/share-graphite-with-your-team.md

@@ -0,0 +1,9 @@
+# Share Graphite with your team
+
+We explicitly designed Graphite so that you can use our CLI & web dashboard without the rest of your team having to change their workflows, but there are a lot of reasons why we think they'll want to adopt Graphite! By virtue of your early access to Graphite, anyone else from your organization can also join the beta without waiting in line - here's how to invite them:
+
+![](../../.gitbook/assets/invite\_team.gif)
+
+{% hint style="info" %}
+Want to invite a friend from a different company?  As a Graphite beta user, you'll also get a limited number of external invites per month, which you can use to send to folks outside of your organization!
+{% endhint %}

guides/graphite-dashboard/team-insights-alpha.md

@@ -0,0 +1,13 @@
+# Team insights \[alpha]
+
+{% hint style="warning" %}
+Team insights is still in alpha - expect frequent updates and improvements!
+{% endhint %}
+
+Graphite's team insights page gives you analytics on how you & your team work.  Ever wonder how many PRs you wrote this month? Or how long it usually takes you to land a PR? Graphite's team insights feature lets you quickly see summary stats for you and your team over any time period:
+
+![](../../.gitbook/assets/team\_insights.gif)
+
+{% hint style="info" %}
+Team insights isn't designed to be a stack rank - it's designed for ICs & managers alike, and it's there to help you better understand how you and your team work.
+{% endhint %}

guides/graphite-dashboard/using-the-review-queue.md

@@ -26,7 +26,7 @@ Each PR in the table has (from left to right):
 * Lines added/deleted
 * Last updated time (by default, the table is sorted by most recently updated)
 
-Clicking each row will take you to the associated pull request in GitHub, or, if you're part of the code review alpha, will take you to the Graphite code review interface for the pull request - more info here:
+Clicking each row will take you to the Graphite code review interface for the pull request - more info here:
 
 {% content-ref url="reviewing-code-with-graphite-alpha.md" %}
 [reviewing-code-with-graphite-alpha.md](reviewing-code-with-graphite-alpha.md)