Skip to content

Commit

Permalink
Merge pull request #18851 from CalvinAllen/codestream-vs
Browse files Browse the repository at this point in the history
CodeStream Doc Updates
  • Loading branch information
rhetoric101 authored Oct 4, 2024
2 parents 96dd767 + 6980f95 commit c1ca25b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ When reporting issues to New Relic customer support it is often helpful to inclu

1. Go to <DNT>**Tools > Options > CodeStream**</DNT> and make sure your log level is set to at least `Debug`. If it is set to `Info`, `Errors`, or `Silent`, change it to `Debug`, then restart Visual Studio.
2. Reproduce the issue.
3. Grab `vs-extension.log` and `vs-agent.log` from `%localappdata%\CodeStream\Logs` as well as the `ActivityLog.xml` from `%AppData%\Microsoft\VisualStudio\16.0_<RandomText>` (for Visual Studio 2019) or `%AppData%\Microsoft\VisualStudio\17.0_<RandomText>` (for Visual Studio 2022).
3. Grab `vs-2022-extension.log` and `vs-2022-agent.log` from `%localappdata%\CodeStream\Logs` as well as the `ActivityLog.xml` from `%AppData%\Microsoft\VisualStudio\17.0_<RandomText>`.
22 changes: 22 additions & 0 deletions src/content/docs/codestream/troubleshooting/using-wsl.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: How can I use WSL and CodeStream?
metaDescription: "You can run CodeStream in Windows using WSL"
freshnessValidatedDate: never
---

To use CodeStream and WSL (Windows Subsystem for Linux), follow these steps:

1. Make sure Git is installed on the Windows machine, as well as in your WSL distro. While the versions installed between the two could differ, its best to ensure the Windows version matches whatever is installed in your WSL distro.
2. Clone your git repo into your WSL distro (for example, `~/code/YOUR_PROJECT_FOLDER`).
3. On Windows, allow git to communicate over this UNC path by marking the directory as `safe`. Do this in your Windows terminal with this command, replacing `YOUR_DISTRO`, `YOUR_USERNAME`, and `YOUR_PROJECT_FOLDER` to match your configuration:
```
git config --global --add safe.directory '//wsl.localhost/YOUR_DISTRO/home/YOUR_USERNAME/code/YOUR_PROJECT_FOLDER'
```

4. In your IDE, open the project using the WSL UNC path. For example, if you had Ubuntu, your username was `codestream`, and project folder was `Amazing_App`, your UNC path would be `//wsl.localhost/Ubuntu/home/codestream/code/Amazing_App`.

<Callout variant="tip">
Git on Windows is only used to make requests to your locally cloned repo in WSL and doesn't need to communicate with the remote (for example, GitHub, GitLab, etc.).
</Callout>

If you have issues after you complete these steps, please [collect your log files](/docs/codestream/troubleshooting/client-logs) and contact New Relic customer support for further investigation.
2 changes: 2 additions & 0 deletions src/nav/codestream.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ pages:
path: /docs/codestream/troubleshooting/proxy-support
- title: JetBrains keychain issue
path: /docs/codestream/troubleshooting/keychain-issues
- title: Using WSL with CodeStream
path: /docs/codestream/troubleshooting/using-wsl

0 comments on commit c1ca25b

Please sign in to comment.