Skip to content

Commit

Permalink
Merge pull request #4468 from planteater/feature/workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
paperclypse committed Oct 25, 2021
2 parents 524842d + 8ebae4b commit 5d8e46b
Show file tree
Hide file tree
Showing 23 changed files with 207 additions and 45 deletions.
@@ -0,0 +1,59 @@
---
title: Sidebar overview
metaDescription: "Here's an overview of the CodeStream sidebar sections."
---

The CodeStream sidebar surfaces all the items you need to see, and do, in a
customizable tree-based view that is always available.

![A screenshot of the CodeStream sidebar sections](./images/Sidebar3.png "The CodeStream sidebar sections.")

<figcaption>The main sidebar sections are: Pull requests, Feedback requests, Codemarks, Observability, and Issues.</figcaption>

## Sidebar overview [#overview]

Here's a quick overview of the sidebar sections:

* [Pull requests](/docs/codestream/codestream-ui-overview/pull-requests-section) - If your team uses GitHub or GitHub Enterprise to host your code, you'll see all of your open pull requests listed here. Click a specific pull request to start reviewing or editing it.
* [Feedback requests](/docs/codestream/codestream-ui-overview/feedback-requests-section) - If you've been assigned a feedback request or you've requested feedback from someone else, find those listed here.
* [Codemarks](/docs/codestream/codestream-ui-overview/codemarks-section) - Codemarks are the discussions that annotate your codebase. Codemarks are created pull requests, feedback requests, or through ad hoc code comments/issues. All of the codemarks in your current repository are listed for reference.
* [Observability](/docs/codestream/codestream-ui-overview/observability-section) - Track errors assigned to you in New Relic One and discover recent errors in the repositories you have open in your IDE.
* [Issues](/docs/codestream/codestream-ui-overview/issues-section) - See all of your open issues, across multiple services, in one place. Click a specific issue to update its status, create a feature branch to do your work, and update your status on Slack.

The CodeStream sidebar is completely customizable:

* Drag and drop the sections to reorder them.
* Click and drag a section divider to resize the sections on either side.
* Expand or collapse each section as needed.
* Click the maximize button in each section to fill the whole screen. This is useful when you're looking at a longer list. Click it again to return to your previous view.

## The username menu [#username]

![A screenshot of the username menu items.](./images/UsernameMenu.png "The username menu items.")

<figcaption>The username menu gives you options for managing your account, your organization, how you receive notifications, and what sections are visible.</figcaption>

Here are descriptions of each menu item:

* **Account**: View your profile. Includes various options for customizing the profile photo, email, username, and full name for your account.
* **View**: Uncheck sections you're not interested in seeing.
* **Notifications**: Manage how and what notifications you receive.
* **Organization admin**: Manage your organization settings. Also, export your data and delete your organization.
* **Switch organization**: Use this if you're a member of more than one organization.
* **Integrations**: Connect CodeStream to the code host, issue, and messaging providers you use.
* **New Relic setup**: Connect your New Relic account to CodeStream to get the most out of New Relic CodeStream's observability tools.
* **Feedback**: Got feedback for us? Write a GitHub issue.
* **Help**: Links to documentation, our video library, keybindings, the CodeStream workflow, what's new, and reporting an issue.

## Header menu items [#header-menu]

![A screenshot of the CodeStream header menu.](./images/GlobalOptions2.png "The CodeStream header menu.")

<figcaption>The header menu items provide different options for creating and discovering content in your organization. From left to right: **Create**, **Activity feed**, **My organization**, and **Filter & search**.</figcaption>

* **+** (Compose) - Click to create a code comment/issue, request feedback on changes, or to create a pull request.
* [Activity feed](/docs/codestream/codestream-ui-overview/activity-feed) - The activity feed will let you know about new code comments/issues and feedback requests, as well as replies to existing ones.
* [My organization](/docs/codestream/codestream-ui-overview/myorganization) - See who is in your CodeStream organization, invite new members, and create blame maps.
* [Filter & search](/docs/codestream/codestream-ui-overview/filter-and-search) - Filter & search allows you to slice and dice your team’s collection of code comments/issues and feature requests however you see fit.


Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -0,0 +1,90 @@
---
title: Performance monitoring with CodeStream
metaDescription: "How to discover and colloborate on errors in CodeStream."
---

It’s important to know how your code is performing in production and whether or not it’s generating errors. To help you with this, New Relic CodeStream brings performance monitoring right into your IDE.

## Connect CodeStream to your New Relic One account [#connect]

Once you’ve [connected CodeStream to your New Relic One account](/docs/codestream/start-here/codestream-new-relic), and you've created one or more workloads with [errors inbox](/docs/errors-inbox/errors-inbox/) on New Relic One, use **Open in IDE** to see APM errors with stack traces directly in your IDE.

![A screenshot of a stack trace error in errors inbox with the "Open in IDE button."](./images/ErrorsInbox.png "A stack trace error in errors inbox with the "Open in IDE button")

<figcaption>When you've connected New Relic CodeStream to your New Relic One account, in errors inbox click **Open in IDE** to see the code that caused the error.</figcaption>

![Error on New Relic One](./images/ErrorOnNR1.png)

Once connected, all of your collaboration work in CodeStream (such as the discussion, assignee, and error status) syncs with New Relic One, where you can continue to collaborate. A typical collaboration session could include developers commenting on code in their IDEs, a DevOps engineer assigning errors in errors inbox, and a development manager following along in Slack. By meeting people in the tools they're already using, New Relic CodeStream shortens the amount of time between error discovery and error resolution.

## CodeStream observability [#observability]

In addition to errors inbox, discover errors in your IDE in the [CodeStream observability section](/docs/codestream/codestream-ui-overview/observability-section). In addition to recent errors in your repos, see any specific errors assigned to you.

![A screenshot of the observability section with recent and assigned stack trace errors.](./images/ObservabilitySection.png "The observability section with recent and assigned stack trace errors.")

<figcaption>Use CodeStream's observability section to keep up to date with recent and assigned stack trace errors.</figcaption>

## Error details [#error-details]

No matter how you've arrived at an error in your IDE, CodeStream presents all of the error’s details, including the stack trace, and you can collaborate with your teammates to resolve the error.

![An animated image that shows someone commenting on a line of code associated with an error.](./images/Observability-VSC.gif "Someone commenting on a line of code associated with an error.")

<figcaption>Click any frame in the stack trace to jump straight to the corresponding file and line number in your IDE. As you navigate the stack trace, if you come across code that seems like the source of your problem, select it and click the comment icon to start collaborating.</figcaption>

## Collaborate with CodeStream [#collaborate]

![A screenshot of a comment with the most recent code contributor automatically added.](./images/ErrorAutoMention.png "A comment with the most recent code contributor automatically added.")

<figcaption>CodeStream automatically mentions the most recent person to touch the code related to the error, making it easy for you to bring the right people into the discussion.</figcaption>

![A screenshot of the CodeStream's error assignment.](./images/ErrorAssignee.png "CodeStream's error assignment.")

<figcaption>Once you’ve identified the problem you can assign the error, either to an existing teammate on CodeStream or to a person suggested based on the repository’s Git commit history.</figcaption>

![A screenshot of the error status dropdown.](./images/ErrorStatus.png "The error status dropdown.")

<figcaption>You can update the error’s status from unresolved to resolved or ignored.</figcaption>

## Use build SHAs with CodeStream [#sha]

![A screenshot of the build SHA not configured warning message.](./images/BuildSHANotConfigured.png "The build SHA not configured warning message.")

<figcaption>The build SHA not configured warning message reads: No build SHA associated with this error. Your version of the code may not match the environment that triggered the error.</figcaption>

You may see this warning if there's no build SHA associated with a specific error.

CodeStream uses the build SHA to match the specific stack trace error with the version of the code running in the environment that triggered the error.

To resolve this warning, [set the environment variables for your APM agent](/docs/codestream/start-here/codestream-new-relic/#buildsha).

Even without the build SHA configured, you can still investigate the error, but you may not be looking at the version of the code that caused it.

![A screenshot of the build SHA not found warning message.](./images/BuildSHANotFound.png "The build SHA not found warning message.")

<figcaption>The build SHA not found warning message reads: Your version of the code doesn't match production. Fetch the following commit to better investigate the error.</figcaption>

If you do have build SHAs configured, but the version of the code you're on locally doesn't contain that commit, CodeStream will let you know so that you can more effectively investigate and resolve the error.

CodeStream will also let you know if the error doesn’t have a stack trace
associated with it. This happens with older errors when the stack trace has
aged out on New Relic One.

## Other collaboration tools [#other-tools]

In an error discussion, use the `...` **More actions** dropdown to share the continue the collaboration on other tools, like Slack or Microsoft Teams.

## Associate your repo [#repo]

![A screenshot of the missing repository info message.](./images/RepoAssociation.png "The missing repository info message.")

<figcaption>If there's no repository associated with CodeStream when you click **Open in IDE** on an error, CodeStream prompts you to do so.</figcaption>

All of the repos you currently have open in your IDE are listed in the **select a repo** dropdown.

If you don’t see the repository you want listed, open it in your IDE and it will
automatically get added to the list. If you’re working with a fork, make sure you select the upstream remote.

To avoid having to do this manual association every time you open an error, you can [make these
associations via your APM agent's environment variables](/docs/codestream/start-here/codestream-new-relic/#repo-url).
6 changes: 3 additions & 3 deletions src/content/docs/codestream/how-use-codestream/start-work.mdx
@@ -1,14 +1,14 @@
---
title: Start working with CodeStream
metaDescription: "An overview of the basic CodeStream workflow."
title: Start work on a new task
metaDescription: "Learn how New Relic CodeStream can simplify your workflow."
---

When you want to get started on some new work, whether it’s a modest bug fix or
a major new feature, there are a lot of steps and different services involved.
Go to your issue tracking service, find all of the issues assigned to you,
select one to work on, and update its status. Now head to your terminal, or
GitHub, to create a feature branch. And lastly, update your status on Slack to
let your teammates know what you’re working on. With CodeStream, you can do this
let your teammates know what you’re working on. With New Relic CodeStream, you can do this
all in one step, right from your IDE.

To get started, look for the Issues section in the CodeStream pane and connect
Expand Down

0 comments on commit 5d8e46b

Please sign in to comment.