Skip to content

Commit

Permalink
Merge branch 'master' of github.com:MicrosoftDocs/live-share
Browse files Browse the repository at this point in the history
  • Loading branch information
lostintangent committed May 22, 2018
2 parents a0e59f0 + a48f8bf commit 1cf4b2c
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 9 deletions.
2 changes: 0 additions & 2 deletions docs/quickstart/share.md
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
20 changes: 20 additions & 0 deletions docs/reference/releases.md
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
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
2 changes: 1 addition & 1 deletion docs/use/vs.md
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
6 changes: 2 additions & 4 deletions docs/use/vscode.md
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

0 comments on commit 1cf4b2c

Please sign in to comment.