Skip to content

Commit

Permalink
Merge pull request #14503 from planteater/feature/o11yonly
Browse files Browse the repository at this point in the history 
Remove non-o11y features
  • Loading branch information
@akristen
akristen authored Sep 11, 2023
2 parents 3a28e8d + d5e8283 commit fa61f37
Show file tree
Hide file tree
Showing 16 changed files with 147 additions and 539 deletions.
94 changes: 65 additions & 29 deletions src/content/docs/codestream/codestream-integrations/msteams-integration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: "How to connect CodeStream to your Microsoft Teams channel."

import codestreamMsteamsCodestreamAppPage from 'images/codestream_screenshot-crop_msteams-codestream-app-page.webp'

import codestreamMsteamsConnect from 'images/codestream_screenshot-connect-msteams.webp'

import codestreamMsteamsCodestreamBotWelcome from 'images/codestream_screenshot-crop_msteams-welcome.webp'

import codestreamMsteamsTokenExample from 'images/codestream_screenshot-crop_msteams-token-example.webp'
Expand All @@ -17,47 +19,81 @@ import codestreamMsteamsCodestreamSelectChannel from 'images/codestream_screensh

import codestreamMsteamsExampleCodestreamMessage from 'images/codestream_screenshot-crop_msteams-example-codestream-message.webp'

Connect New Relic CodeStream to your Microsoft Teams channel.
Connect New Relic CodeStream to your Microsoft Teams organization.

When you post a codemark your teammates will get notified via the activity feed, and potentially via email. Sometimes, though, you might want to share to Microsoft Teams as well. This would allow you to reach people who haven’t yet joined CodeStream, or maybe don’t spend a lot of time in their IDE.
When you post a comment or issue your teammates will get notified via the activity feed, and potentially via email. Sometimes, though, you might want to share to Microsoft Teams as well. This would allow you to reach people who haven’t yet joined CodeStream, or maybe don’t spend a lot of time in their IDE.

## Connect to Microsoft Teams [#connect]

1. [Click here to install the CodeStream app](https://teams.microsoft.com/l/app/7cf49ab7-8b65-4407-b494-f02b525eef2b?source=store-copy-link) or go to apps in your Microsoft Teams sidebar and search for CodeStream.
2. Once installed you should see the following popup for the CodeStream app, click the **Add** button. Note, do not expand it and select the options to add to team or chat. Simply click Add.
<img title="Add" alt="A screenshot showing the Add button." src={codestreamMsteamsCodestreamAppPage}/>
3. This will take you to your private chat with the CodeStream bot, and you’ll see the CodeStream logo appear in the Teams sidebar. Click the **Sign In** button in the bot's welcome message, or type `signin` in this chat and submit.
<img title="Weclome" alt="A screenshot showing the bot welcome message." src={codestreamMsteamsCodestreamBotWelcome}/>
4. You'll be taken to the web and prompted to sign into CodeStream.
5. After signing in, you're given a token that you’ll need to copy and paste into your chat with the CodeStream bot back in MS Teams.
6. Paste the token into the chat and submit.
<img title="Token" alt="An image showing where to paste the token." src={codestreamMsteamsTokenExample}/>
<figcaption>Add the token directly into the chat.</figcaption>
7. Go to a channel in which you’d like to share, type `@`, and then select **Get bots** in the popup.
<img title="Bots" alt="An image showing the popup that appears when typing @" src={codestreamMsteamsAddBotButton}/>
8. Select the CodeStream bot from the list (you can search for it if you need to), and then click **Add**.
9. Return to the channel and @mention the CodeStream bot with the `connect` command. Repeat this in any channel that you'd like to share to.
<img title="Connect bot" alt="An image showing the command to connect a bot." src={codestreamMsteamsCodestreamConnectBotMessage}/>
<figcaption>Use this command to connect the bot.</figcaption>
10. Once you get a confirmation, you’re ready to share to Teams from CodeStream.
11. When you return to CodeStream you'll now be able to share to the channels that you just connected.
<img title="Share to channel" alt="An image showing the the CodeStream UI for sharing to a channel" src={codestreamMsteamsCodestreamSelectChannel}/>
<figcaption>Select a channel to share to from your IDE.</figcaption>
1. Go to the **Integrations** page under the username menu in CodeStream and click on the **Microsoft Teams** button.
2. Copy the sign-in code displayed and then click on the **Connect to Teams** button.

<img
title="Connect to Microsoft Teams"
alt="A screenshot showing the page to connect to Microsoft Teams."
src={codestreamMsteamsConnect}
/>

3. You'll be taken to Teams where you should see the following popup for the CodeStream app. Click the **Add** button. Note, do not expand it and select the options to add to team or chat. Simply click Add.

<img
title="Add"
alt="A screenshot showing the Add button."
src={codestreamMsteamsCodestreamAppPage}
/>

4. This will take you to your private chat with the CodeStream bot, and you’ll see the CodeStream logo appear in the Teams sidebar. Click the **Sign In** button in the bot's welcome message, or type `signin` in this chat and submit.

<img
title="Weclome"
alt="A screenshot showing the bot welcome message."
src={codestreamMsteamsCodestreamBotWelcome}
/>

5. Paste your sign-in token into the popup and then click on the **Sign-in** button.

<img
title="Token"
alt="An image showing where to paste the token."
src={codestreamMsteamsTokenExample}
/>

6. Go to a channel in which you’d like to share, type `@`, and then select **Get bots** in the popup.

<img
title="Bots"
alt="An image showing the popup that appears when typing @"
src={codestreamMsteamsAddBotButton}
/>

7. Select the CodeStream bot from the list (you can search for it if you need to), and then click **Add**.
8. Return to the channel and @mention the CodeStream bot with the `connect` command. Repeat this in any channel that you'd like to share to.

<img
title="Connect bot"
alt="An image showing the command to connect a bot."
src={codestreamMsteamsCodestreamConnectBotMessage}
/>

9. Once you get a confirmation, you’re ready to share to Teams from CodeStream.
10. When you return to CodeStream you'll now be able to share to the channels that you just connected.

<img
title="Share to channel"
alt="An image showing the the CodeStream UI for sharing to a channel"
src={codestreamMsteamsCodestreamSelectChannel}
/>

## Participate in CodeStream from Microsoft Teams [#participate]

When you share to Microsoft Teams, not only does it notify your teammates about the codemark, but they can use it to jump directly into their IDEs to participate in the conversation on CodeStream.

<img
title="Teams UI"
alt="An image showing the buttons your team can select from teams."
src={codestreamMsteamsExampleCodestreamMessage}
title="Teams UI"
alt="An image showing the buttons your team can select from teams."
src={codestreamMsteamsExampleCodestreamMessage}
/>

<figcaption>
This will open the codemark in their designated IDE.
</figcaption>

### Open in IDE [#open-ide]

Click **Open in IDE** to view both the code and the discussion right inside your IDE. You’re taken through a CodeStream web page where you can choose which IDE to open. CodeStream remembers your selection the next time you view a discussion from the same repository. You’re then taken to the appropriate source file in your IDE, scrolled to the relevant block of code, with the discussion displayed in the CodeStream pane. If you don’t happen to have that repository open in your IDE, CodeStream will automatically open the source file for you (assuming you’ve opened that repository previously, with CodeStream installed, so that we know where to find it).
Expand Down
18 changes: 4 additions & 14 deletions src/content/docs/codestream/codestream-integrations/notifications.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@ import codestreamCodestreamDesktopNotification from 'images/codestream_screensho

import codestreamCodestreamPullRequestNotification from 'images/codestream_screenshot-crop_codestream-pull-request-notification.webp'

New Relic CodeStream will notify you about codemarks and feedback requests that you follow. Look for the **Notifications** option under your user profile menu at the top of the CodeStream pane.
CodeStream will notify you about comments and issues that you follow. Look for the **Notifications** option under your user profile menu at the top of the CodeStream pane.

## Notifications for codemarks and feedback requests [#codemarksandFRs]
## Notifications for comments and issues [#codemarksandFRs]

By default, you're set to automatically follow any codemark or feedback request that you created, where you’ve been mentioned (either in the original post or in a subsequent reply), or to which you’ve replied. You can always choose to follow or unfollow any individual codemark or feedback request via its ellipses menu.
By default, you're set to automatically follow any comment or issue that you created, where you’ve been mentioned (either in the original post or in a subsequent reply), or to which you’ve replied. You can always choose to follow or unfollow any individual comment or issue via its ellipses menu.

You can choose whether you want to be notified via email, desktop, or both. Email notifications are sent immediately, and you can participate in the
discussion by replying to the email. Your reply will get added to CodeStream as a reply to the appropriate codemark or feedback request. Be sure that when you reply you're doing so from the same email address where the notification was sent (that is, your email address listed in **My Organization** on CodeStream).
You can choose whether you want to be notified via email, desktop, or both. Email notifications are sent immediately, and you can participate in the discussion by replying to the email. Your reply will get added to CodeStream as a reply to the appropriate comment or issue. Be sure that when you reply you're doing so from the same email address where the notification was sent (that is, your email address as show on your **Profile** on CodeStream).

Desktop notifications in the IDE are only available if you’re using VS Code or a JetBrains IDE.

Expand All @@ -32,22 +31,13 @@ Desktop notifications in the IDE are only available if you’re using VS Code or

CodeStream also offers the following email notifications.

* **Send me an email reminder for outstanding feedback requests**: Get an email reminder about open feedback requests assigned to you that you haven't responded to in the last 24 hours.
* **Send me weekly emails summarizing my activity**: Sent every Monday with information about you and your organization's activity for the previous week.

## Additional desktop notifications [#additionaldesktop]

CodeStream also offers the following desktop notifications.

* **Notify me about performance issues**: New methods in the code that are performing poorly will trigger a toast notification, based on code-level metrics [anomaly detection](/docs/codestream/how-use-codestream/performance-monitoriing#clm-anomalies). Note that if you have multiple repositories open in your IDE and/or multiple services associated with those repositories, you'll only get notified about the first method with anomalous performance. Be sure to check **Code-Level Metrics** in the **Observability** section for the complete list.
* **Notify me about new unreviewed commits from teammates when I pull**: Any time you pull, if there are new commits from a teammate on the current branch you'll get a toast notification. Click the **Review** button to start reviewing your teammate's changes and provide feedback.
* **Notify me about pull requests assigned to me**: If you've connected to GitHub, GitHub Enterprise, GitLab or GitLab Self-Managed to leverage CodeStream's [pull request integration](/docs/codestream/how-use-codestream/pull-requests), you'll also be notified when a pull request is assigned to you or you are added as a reviewer.

<img
title="Pull request"
alt="An image showing the pull request notification."
src={codestreamCodestreamPullRequestNotification}
/>

<figcaption>
Click the **Open** button to open the pull request right in your IDE where you can review the changes.
Expand Down
23 changes: 1 addition & 22 deletions src/content/docs/codestream/codestream-settings/team-administration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ While non-admins can only create blame maps for themselves, admins can create bl

## Organization settings [#organization-settings]

If you're an admin, use the **Organization Admin** menu under the headshot menu at the top of the CodeStream pane to change your organization's name, manage [onboarding](#onboarding) and [feedback requests](#feedback-request) settings, [export data](#export), or delete your org.
If you're an admin, use the **Organization Admin** menu under the username menu at the top of the CodeStream pane to change your organization's name, manage [onboarding](#onboarding) settings, [export data](#export), or delete your org.

<img
title="Organization settings"
Expand All @@ -75,27 +75,6 @@ If you're an admin, use the **Organization Admin** menu under the headshot menu

Domain-based joining allows anyone with email addresses on the specified domains to join your CodeStream organization without being first invited. Not only does this make it very easy to get your teammates on board, but it ensures that they'll be part of your organization (as opposed to accidentally creating their own).

### Feedback request assignment and approval [#feedback-requests]

Admins can control how both feedback request assignments and approvals work for your organization.

<img
title="Feedback request settings"
alt="This image shows the feedback request settings tab and all its options."
src={codestreamFeedbackRequestTeamSettings}
/>

<figcaption>
Use the feedback request settings to fine tune your organization's feedback process.
</figcaption>

By default, the person requesting feedback can decide how approvals work, but you can, instead, set a default behavior for all feedback requests for the organization.

* **Any reviewer can approve**: Anyone can approve the feedback request, regardless of how many reviewers are assigned.
* **All reviewers must approve individually**: Each assigned reviewer must individually approve the feedback request before it's considered approved.

You can also decide if and how CodeStream suggests reviewers. **Round-robin** will cycle through all developers in the organization. **Random** will randomly assign the feedback request to any developer in the organization. The **Authorship** options will suggest up to three reviewers based on the developers who wrote the lines of code impacted by the changes, as well as other developers who may have committed to the branch.

### Export your data [#export]

There's a lightweight export tool for getting your organization's discussions out of CodeStream.
Loading

0 comments on commit fa61f37

Please sign in to comment.