Add article on Live Share to the Codespaces docs (#34065)
Co-authored-by: github-actions <github-actions@github.com>
This commit is contained in:
BIN
assets/images/help/codespaces/live-share-click-icon.png
Normal file
BIN
assets/images/help/codespaces/live-share-click-icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
BIN
assets/images/help/codespaces/live-share-click-share.png
Normal file
BIN
assets/images/help/codespaces/live-share-click-share.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
BIN
assets/images/help/codespaces/live-share-enable-rightclick.png
Normal file
BIN
assets/images/help/codespaces/live-share-enable-rightclick.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
assets/images/help/codespaces/live-share-search-extensions.png
Normal file
BIN
assets/images/help/codespaces/live-share-search-extensions.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 93 KiB |
BIN
assets/images/help/codespaces/live-share-stop-collaboration.png
Normal file
BIN
assets/images/help/codespaces/live-share-stop-collaboration.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
@@ -12,6 +12,7 @@ children:
|
|||||||
- /creating-a-codespace-from-a-template
|
- /creating-a-codespace-from-a-template
|
||||||
- /deleting-a-codespace
|
- /deleting-a-codespace
|
||||||
- /opening-an-existing-codespace
|
- /opening-an-existing-codespace
|
||||||
|
- /working-collaboratively-in-a-codespace
|
||||||
- /using-source-control-in-your-codespace
|
- /using-source-control-in-your-codespace
|
||||||
- /using-github-codespaces-for-pull-requests
|
- /using-github-codespaces-for-pull-requests
|
||||||
- /stopping-and-starting-a-codespace
|
- /stopping-and-starting-a-codespace
|
||||||
|
|||||||
@@ -0,0 +1,64 @@
|
|||||||
|
---
|
||||||
|
title: Working collaboratively in a codespace
|
||||||
|
shortTitle: Work collaboratively
|
||||||
|
intro: You can work collaboratively with other people in a codespace by using {% data variables.product.prodname_vs %} Live Share.
|
||||||
|
versions:
|
||||||
|
fpt: '*'
|
||||||
|
ghec: '*'
|
||||||
|
type: how_to
|
||||||
|
topics:
|
||||||
|
- Codespaces
|
||||||
|
- Developer
|
||||||
|
---
|
||||||
|
|
||||||
|
{% data variables.product.prodname_vs %} Live Share lets you collaboratively edit and debug with others in real time, within a codespace. You can securely share your current codespace, or access a codespace created by someone else.
|
||||||
|
|
||||||
|
You can start a Live Share session either within the {% data variables.product.prodname_vscode_shortname %} web client in your browser, or within the {% data variables.product.prodname_vscode_shortname %} desktop application.
|
||||||
|
|
||||||
|
For more information about Live Share, see "[What is {% data variables.product.prodname_vs %} Live Share?](https://learn.microsoft.com/en-us/visualstudio/liveshare/)" in the {% data variables.product.prodname_vs %} documentation.
|
||||||
|
|
||||||
|
## Sharing your codespace with someone else
|
||||||
|
|
||||||
|
1. In the Activity Bar, click the Extensions icon.
|
||||||
|
1. In the search box, type `Live Share`.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
1. If the **Install** button is displayed beside the extension, click it to install the extension in the codespace.
|
||||||
|
1. If the extension is shown grayed out in the list, right-click it and click **Enable**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
1. In the Activity Bar, click the Live Share icon.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
1. Click **Share**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
A "toast" notification message is displayed at the bottom right corner of {% data variables.product.prodname_vscode_shortname %}, telling you that a link to your codespace has been copied to the clipboard. You can click **Make read-only** if you want to prevent guests from making changes to the files you share with them.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
1. Send the link in your clipboard to anyone you want to join you in your Live Share session.
|
||||||
|
|
||||||
|
{% note %}
|
||||||
|
|
||||||
|
**Important**: Given the level of access Live Share sessions can provide to guests, you should only share with people you trust, and you should think through the implications of what you are sharing. For more information, see "[Security features of Live Share](https://learn.microsoft.com/en-us/visualstudio/liveshare/reference/security)" in the {% data variables.product.prodname_vs %} documentation.
|
||||||
|
|
||||||
|
{% endnote %}
|
||||||
|
|
||||||
|
## Stopping a Live Share session
|
||||||
|
|
||||||
|
To stop sharing your codespace, click the stop icon in the Live Share panel.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
If you, as the person who started the Live Share session, close the codespace the sharing session ends, even if the codespace remains active on the remote host.
|
||||||
|
|
||||||
|
The idle timeout, which automatically stops a codespace after a period of inactivity, only applies to the person who started the codespace. It does not apply to people who are working on the codespace via Live Share. The codespace may therefore time out while collaborators are using the codespace if the person who started the codespace remains inactive for the configured period of time. For more information, see "[Setting your timeout period for GitHub Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)."
|
||||||
|
|
||||||
|
## Working collaboratively in someone else's codespace
|
||||||
|
|
||||||
|
If you want to work with someone within a codespace they've created, ask them to set up a Live Share session and send you a link, as described above.
|
||||||
@@ -28,6 +28,7 @@ includeGuides:
|
|||||||
- /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace
|
- /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace
|
||||||
- /codespaces/developing-in-codespaces/opening-an-existing-codespace
|
- /codespaces/developing-in-codespaces/opening-an-existing-codespace
|
||||||
- /codespaces/developing-in-codespaces/stopping-and-starting-a-codespace
|
- /codespaces/developing-in-codespaces/stopping-and-starting-a-codespace
|
||||||
|
- /codespaces/developing-in-codespaces/working-collaboratively-in-a-codespace
|
||||||
- /codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code
|
- /codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code
|
||||||
- /codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide
|
- /codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide
|
||||||
- /codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli
|
- /codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli
|
||||||
|
|||||||
@@ -110,11 +110,15 @@ Depending on the size of your codebase, and the memory needed to run your applic
|
|||||||
|
|
||||||
### Client can't be opened in MacOS Ventura
|
### Client can't be opened in MacOS Ventura
|
||||||
|
|
||||||
In MacOS Ventura, the first time you try to connect to a codespace from the JetBrains Gateway a message may be displayed telling you that the JetBrains client application "is damaged and can't be opened."
|
In MacOS Ventura, using versions of the JetBrains Gateway prior to version 2022.3, the first time you try to connect to a codespace from the JetBrains Gateway a message was displayed telling you that the JetBrains client application "is damaged and can't be opened."
|
||||||
|
|
||||||
<img src="/assets/images/help/codespaces/jetbrains-ventura-error1.png" alt="Screenshot of the 'cannot be opened' error message" style="width:230px;"/>
|
<img src="/assets/images/help/codespaces/jetbrains-ventura-error1.png" alt="Screenshot of the 'cannot be opened' error message" style="width:230px;"/>
|
||||||
|
|
||||||
If this happens:
|
This issue is fixed in the JetBrains Gateway, version 2022.3 and later.
|
||||||
|
|
||||||
|
To avoid this issue, update the JetBrains Gateway.
|
||||||
|
|
||||||
|
To work around this problem with older versions of the Gateway:
|
||||||
|
|
||||||
1. Click **Cancel** to dismiss this message.
|
1. Click **Cancel** to dismiss this message.
|
||||||
1. Click the Apple icon, top left of the screen, and click **System Settings**.
|
1. Click the Apple icon, top left of the screen, and click **System Settings**.
|
||||||
|
|||||||
Reference in New Issue
Block a user