Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel committed Jun 8, 2018
2 parents cd68027 + a5ca7e5 commit e065718
Show file tree
Hide file tree
Showing 17 changed files with 169 additions and 63 deletions.
4 changes: 3 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,7 @@
"MD013": false,
"MD034": false,
"MD026": false
}
},
"favorites.sortDirection": "ASC",
"favorites.groupsFirst": true
}
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Many Visual Studio Live Features are available across a number of languages and

## Community-created content

- [Getting Started with Live Coding in Visual Studio Code w/Live Share](https://scotch.io/tutorials/getting-started-with-live-coding-in-visual-studio-code-with-live-share)
- [Visual Studio Code: VS Live Share from Across the World](https://youtu.be/D7w0uGmQEc8)
- [Visual Studio Live Share - Two Developers Coding at Once](https://youtu.be/cg6pRv0D8pw)

Expand Down
3 changes: 3 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ Live Share goes a step further and enables you to share a debug session. This m
## Which languages and platforms will be supported in the preview?
However, our goal is to support the diverse landscape of languages and platforms, to ensure we can enable rich collaboration, regardless of the application type being developed. See the [language and platform support](reference/platform-support.md) article for details on what works today. This is just the start, and we expect to improve this picture moving forward based on feedback.

## How many developers can join a collaboration session?
We currently support five concurrent guests, in addition to the developer that is sharing ("hosting") their project. Therefore, a collaboration session can have a total of six developers in it at any given time. That said, this is an area we're looking for feedback on, so if you have a use case that requires a higher limit, please [let us know](https://github.com/MicrosoftDocs/live-share/issues/229)!

## What is the roadmap?
You can view the set of known issues, and roadmap items [here](http://aka.ms/vsls-issues). If you'd like to see only feature requests rather than all issues, see [here](https://aka.ms/vsls-feature-requests). We encourage you to up-vote existing items, file new feature requests, and log bug reports, in order to help us shape the direction of the product moving forward.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ All rights reserved.
Creative Commons Attribution 4.0 License (International): https://creativecommons.org/licenses/by/4.0/legalcode
-->

# Visual Studio Live Share
# What is Visual Studio Live Share?

> **Note: Visual Studio Live Share is currently in preview. Features and user experience is not final.**
Expand Down
Binary file added docs/media/no-profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/profile-deleted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/user-profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/quickstart/share.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,6 @@ Use your normal workflow to open a folder, project, or solution that you would l

By default, Live Share **hides** any files/folders referenced in .gitignore files in your shared folders from guests. **Hiding** a file prevents it from appearing in the guest's file tree. **Excluding** a file applies a stricter rule that prevents Live Share from opening it for the guest in situations like go to definition or if you step into the file while debugging or being "followed". If you want to hide/exclude different files, a **.vsls.json** file can be added to your project with these settings. See [controlling file access and visibility](../reference/security.md#controlling-file-access-and-visibility) for details.

> **Warning:** This feature has a known issue with **case sensitive filesystems** like those commonly used with **Linux** and in some **rare cases macOS**. (macOS's default filesystem is *not* case sensitive.) If you are hosting from a machine with a case sensitive filesystem, certain files or folders may still appear to guests. You can find more about the bug and [upvote (👍) it here](https://github.com/MicrosoftDocs/live-share/issues/301).
### 5. Start a collaboration session

Next, simply click "Share" within your tool and an invite link is automatically copied to your clipboard.
Expand Down
74 changes: 38 additions & 36 deletions docs/reference/linux.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/reference/platform-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ While most languages have some single file Intellisense support, there are some
| Web app (Front-end) | ✅ <sup>2</sup> | ✅ <sup>3</sup> |
| Azure Functions || ✅ <sup>5</sup> |
| Azure Service Fabric || ✅ <sup>5</sup> |
| [Visual Studio Connected Environment for AKS](https://landinghub.visualstudio.com/vsce) || ✅ <sup>1</sup> |
| [Azure Dev Spaces](http://aka.ms/devspaces) || ✅ <sup>1</sup> |
| Databases | <sup>4</sup> | ✅ <sup>5</sup> |
| Console / CLI || ✅ <sup>6</sup> |
| Desktop (WinForms) || |
Expand Down
20 changes: 20 additions & 0 deletions docs/reference/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,26 @@ Creative Commons Attribution 4.0 License (International): https://creativecommon

What to know what has changed recently? You're in the right spot. You can also view this same information from the releases tab on our [GitHub repo](https://aka.ms/vsls-releases).

## v0.3.198 (VS Code / Visual Studio)

**Note: Assets are for [documentation](http://aka.ms/vsls-docs) not the product source code.**

This is largely a bug fix release that resolves some frequently-reported user issues. We really appreciate all of the usage/feedback, so please keep letting us know how to improve! 💯

### Feature Enhancements (VS/VSCode) 🚀

1. *Guest Leave Notification* (#95) - Users now receive a notification when a guest leaves the collaboration session. We had previously introduced notifications for when a guest joins the session, and so this release completes the request described in #95.

### User-Reported Issues (VS/VSCode)

1. *Fixes for hosts with case-sensitive file systems* (#301, #302, #303) - We had previously introduced the ability for guests to add/delete/rename files, as well as for hosts to hide certain files from guests (e.g. secrets). However, those features experiences issues when the host was using a case-sensitive file system. This release resolves these bugs, and ensures the correct behavior regardless of the filesystem the host is using.

1. *Fix for shared terminals when using a custom shell* (#361) - The shared terminal feature already allowed you to specify a custom shell, however, it required you to specify it as an absolute file path. With this release, you can now specify just the shell name (e.g. `fish`), and it will correctly resolve it based on your `PATH`.

### User-Reported Issues (VS Code/macOS)

1. *Resolving 100% CPU consumption on macOS* (#355) - We heard numerous reports of macOS users seeing the Live Share agent process (`vsls-agent`) consuming 100% of their CPU, even when they weren't sharing. This release resolves that issue, to ensure that Live Share is lean and mean!

## v0.3.125 (VS Code / Visual Studio)

These are bug fix releases that resolve a number of telemetry reported and two user reported issues. We really appreciate all of the usage/feedback, so please keep letting us know how to improve! 💯
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,6 @@ As a guest, if you join a session where the host has this setting enabled, you'l

## Controlling file access and visibility

> **Warning:** This feature has a known issue with **case sensitive filesystems** like those commonly used with **Linux** and in some **rare cases macOS**. (macOS's default filesystem is _not_ case sensitive.) If you are **hosting** from a machine with a case sensitive filesystem, certain files or folders may still appear to guests. (Guest's filesystems have no effect on the bug.) You can find more about the bug and [upvote (👍) it here](https://github.com/MicrosoftDocs/live-share/issues/301). We are working to resolve it ASAP.
As a guest, Live Share's remote model gives you quick read/write access to files and folders the host has shared with you without having to sync the entire contents of a project. You can therefore independently navigate and edit files in the entire shared file tree. **However, this freedom does pose some risks to the host.** In concept, a developer could opt to go in and modify source code without your knowledge or see sensitive source code or "secrets" located somewhere in the shared file tree. Consequently, as a host, you may not always want the guest to have access to the entirety of a project you are sharing. Thankfully, an added advantage of this remote model is that you can opt to "exclude" files you do not want to share with anyone without sacrificing on functionality. Your guests can still participate in things like debugging sessions that would normally require access to these files if they wanted to do so on their own.

You can accomplish this by adding a **.vsls.json** file to the folder or project you are sharing. Any settings you add to this json formatted file changes how Live Share processes files. In addition to providing you direct control, these files can also be committed to source control so anyone cloning a project will be able to take advantage of these rules with no additional effort on their part.
Expand Down
7 changes: 3 additions & 4 deletions docs/toc.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<!-- markdownlint-disable MD022 MD025 -->
# Overview
## [Introduction](index.md)
## [Concepts and features](index.md#concepts-and-features)
## [What is Visual Studio Live Share?](index.md)
# Quickstarts
## [Share your first project](quickstart/share.md)
## [Join your first session](quickstart/join.md)
# How-tos: VS Code
# How-to Guides: VS Code
## [Overview](use/vscode.md)
## [Install](use/vscode.md#installation)
## [Sign-in](use/vscode.md#sign-in)
Expand All @@ -16,7 +15,7 @@
## [Co-debug](use/vscode.md#co-debugging)
## [Share a server](use/vscode.md#share-a-server)
## [Share a terminal](use/vscode.md#share-a-terminal)
# How-tos: Visual Studio
# How-to Guides: Visual Studio
## [Overview](use/vs.md)
## [Install](use/vs.md#installation)
## [Sign-in](use/vs.md#sign-in)
Expand Down
2 changes: 1 addition & 1 deletion docs/use/vs.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Beyond cursors and edits, selections you make are also visible to all participan

Better yet, you and other participants can navigate to any file in the shared project. You can can either edit together or independently meaning you can seamlessly switch between investigation, making small tweaks, and full collaborative editing.

> **Note:** Guest support for file navigation and file operations is still in development and has some limitations. Find in files is not yet implemented [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/43). Guests will always see a file view of solutions shared from Visual Studio [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/43). Files outside of the solution "root" folder in VS are not shared [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/46). When the host is using a case sensitive filesystem (e.g. Linux), file updates (add / rename / delete) may not propagate to guests [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/302) and if multiple files or folders with the same name but different casing exist in the same path, only one may appear [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/303).
> **Note:** Guest support for file navigation and file operations is still in development and has some limitations. Find in files is not yet implemented [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/43). Guests will always see a file view of solutions shared from Visual Studio [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/43). Files outside of the solution "root" folder in VS are not shared [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/46).
The resulting edits are persisted on the host's machine on save so there is no need to synchronize, push, or send files around once you're done editing. The edits are "just there."

Expand Down
8 changes: 3 additions & 5 deletions docs/use/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Some distributions of Linux are missing libraries Live Share needs to function.

When you click "Install", a terminal window will appear where you'll need to enter your admin (sudo) password to continue. Assuming it completes successfully, restart Visual Studio Code you should be all set! You may also want to check out **[tips by distribution](../reference/linux.md#tips-by-distribution)** for other hints and workarounds if any exist.

If you see a message indicating the script does not support your distribution, see **[tips for unsupported distributions](../reference/linux.md#tips-for-unsupported-distros)** for community tips and issues.
If you see a message indicating the script does not support your distribution, see **[tips for community supported distributions](../reference/linux.md#tips-for-community-supported-distros)** for information the community has shared with us.

If you **prefer not to have VS Code run the command for you**, you can also opt to re-run the very latest version of this script at any time manually by running the following command from a Terminal window:

Expand Down Expand Up @@ -147,8 +147,6 @@ After downloading and installing Visual Studio Live Share, follow these steps to

By default, Live Share **hides** any files/folders referenced in .gitignore files in your shared folders from guests. **Hiding** a file prevents it from appearing in the guest's file tree. **Excluding** a file applies a stricter rule that will prevent Live Share from opening it for the guest in situations like go to definition or if you step into the file while debugging or being "followed". If you want to hide/exclude different files, a **.vsls.json** file can be added to your project with these settings. See [controlling file access and visibility](../reference/security.md#controlling-file-access-and-visibility) for details.

> **Warning:** This feature has a known issue with **case sensitive filesystems** like those commonly used with **Linux** and in some **rare cases macOS**. (macOS's default filesystem is *not* case sensitive.) If you are hosting from a machine with a case sensitive filesystem, certain files or folders may still appear to guests. You can find more about the bug and [upvote (👍) it here](https://github.com/MicrosoftDocs/live-share/issues/301).
4. **Start a collaboration session**

Now, simply click the "Share" status bar item or hit **Ctrl+Shift+P** and select "Live Share: Start a collaboration session (Share)".
Expand Down Expand Up @@ -283,11 +281,11 @@ Beyond cursors and edits, selections you make are also visible to all participan

Better yet, you and other participants can navigate to any file in the shared project. You can either edit together or independently meaning you can seamlessly switch between investigation, making small tweaks, and full collaborative editing.

> **Note:** Guest support for file navigation and file operations is still in development and has some limitations. Find in files is not yet implemented [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/43). Sharing multi-root workspaces are not yet supported [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/46). When the host is using a case sensitive filesystem (e.g. Linux), file updates (add / rename / delete) may not propagate to guests [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/302) and if multiple files or folders with the same name but different casing exist in the same path, only one may appear [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/303).
> **Note:** Guest support for file navigation and file operations is still in development and has some limitations. Find in files is not yet implemented [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/43). Sharing multi-root workspaces are not yet supported [(up-vote 👍)](https://github.com/MicrosoftDocs/live-share/issues/46).
The resulting edits are persisted on the host's machine on save so there is no need to synchronize, push, or send files around once you're done editing. The edits are "just there."

> **Security Tip:** Given all participants can independently navigate and edit files, as a host, you may want to restrict which files guests are able to access in your project via a .vsls.json file. As a guest, it is also important to realize you may not see certain files as a result of these settings. See [controlling file access and visibility](../reference/security.md#controlling-file-access-and-visibility) for details. Note that this feature **does not currently work on case sensitive filesystems**. You can find more about the bug and [upvote (👍) it here](https://github.com/MicrosoftDocs/live-share/issues/301).
> **Security Tip:** Given all participants can independently navigate and edit files, as a host, you may want to restrict which files guests are able to access in your project via a .vsls.json file. As a guest, it is also important to realize you may not see certain files as a result of these settings. See [controlling file access and visibility](../reference/security.md#controlling-file-access-and-visibility) for details.
### Changing participant flag behaviors

Expand Down
61 changes: 61 additions & 0 deletions docs/user-profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "User Profile - Visual Studio Live Share | Microsoft Docs"
description: "An overview of how to view and remove your Visual Studio Live Share user profile."
ms.custom:
ms.date: 05/222/2018
ms.reviewer: ""
ms.suite: ""
ms.technology:
- "liveshare"
ms.topic: "reference"
author: "lostintangent"
ms.author: "joncart"
manager: "AmandaSilver"
ms.workload:
- "liveshare"
---

<!--
Copyright © Microsoft Corporation
All rights reserved.
Creative Commons Attribution 4.0 License (International): https://creativecommons.org/licenses/by/4.0/legalcode
-->

# User Profile

When you authenticate with Visual Studio Live Share, it creates a user profile for you, which allows any participants you collaborate with to see who you are (e.g. your e-mail address, avatar). At any given time, you can view the profile information that Live Share has stored on your behalf, by navigating to one of the following pages (depending on the identity provider you used):

* [Microsoft Account / Azure Active Directory](https://insiders.liveshare.vsengsaas.visualstudio.com/auth/identity/microsoft/viewprofile)
* [GitHub](https://insiders.liveshare.vsengsaas.visualstudio.com/auth/identity/github/viewprofile)

The page will ask you to sign-in to verify your identity, and then display the raw JSON output for your user profile.

<img width="500px" src="media/user-profile.png" />

If Visual Studio Live Share doesn't currently have a profile stored for the identity you logged in with, then it will let you know that as well.

<img width="500px" src="media/no-profile.png" />

## Removing Your Profile

If you'd like to remove your user profile, you can click the link titled `Click here to get your data removed from our systems` on the [user profile page](#user-profile). Alternatively, you can visit one of the following pages directly (depending on the identity provider you used):

* [Microsoft Account / Azure Active Directory](https://insiders.liveshare.vsengsaas.visualstudio.com/auth/identity/microsoft/deleteme)
* [GitHub](https://insiders.liveshare.vsengsaas.visualstudio.com/auth/identity/github/deleteme)

Otherwise, Visual Studio Live Share will automatically delete your profile 30 days after your last successful sign-in. In this context, a "successful sign-in" refers to the following (depending on the tool you're using):

| IDE/Editor | Your user profile will be deleted 30 days after the last time you... |
|-|-|
| Visual Studio | Launch a new instance of the IDE. In order to support single sign-on, Visual Studio Live Share refreshes your authentication session every time you open a new instance of Visual Studio. |
| Visual Studio Code | Complete the browser-based authentication workflow (e.g. clicking the `Sign In` button or running the `Live Share: Sign in with browser` command). Visual Studio Live Share will remember your authentication session on the client, to prevent you from needing to sign-in every time you share. However, that session expires after 30 days, and is never automatically refreshed, until you explicit sign-in through the browser again. |

## See also

- [Language and platform support](reference/platform-support.md)
- [Connectivity requirements for Live Share](reference/connectivity.md)
- [Security features of Live Share](reference/security.md)
- [All major bugs, feature requests, and limitations](https://aka.ms/vsls-issues)
- [All feature requests and limitations](https://aka.ms/vsls-feature-requests)

Having problems? See [troubleshooting](troubleshooting.md) or [provide feedback](support.md).
Loading

0 comments on commit e065718

Please sign in to comment.