Merge pull request #23114 from github/repo-sync

repo sync

content/codespaces/codespaces-reference/security-in-github-codespaces.md

@@ -114,3 +114,7 @@ Certain development features can potentially add risk to your environment. For e
 #### Using extensions
 
 Any additional {% data variables.product.prodname_vscode_shortname %} extensions that you've installed can potentially introduce more risk. To help mitigate this risk, ensure that the you only install trusted extensions, and that they are always kept up to date.
+
+#### Using Settings Sync
+
+{% data variables.product.prodname_vscode_shortname %}'s Settings Sync can allow potentially malicious content to transfer across devices. If you're creating a codespace for a repository whose contents you do not trust, you should open the codespace in the browser and leave Settings Sync disabled.

content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md

@@ -31,13 +31,35 @@ Project maintainers can also define a default configuration that applies to ever
 
 ## Settings Sync
 
-Settings Sync allows you to synchronize configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode_shortname %}.
+Settings Sync allows you to synchronize configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode_shortname %}. For more information, see [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode_shortname %} documentation.
 
-To enable Settings Sync, in the bottom-left corner of {% data variables.product.prodname_vscode %}'s Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Turn on Settings Sync…**. In the dialog box, select the settings you'd like to sync.
+{% data reusables.codespaces.about-settings-sync %}
 
-![Setting Sync option in manage menu](/assets/images/help/codespaces/codespaces-manage-settings-sync.png)
+- If you open a codespace in the browser, Settings Sync is always disabled at first. This means the transfer of settings takes place in one direction and at one time only: {% data variables.product.prodname_github_codespaces %} pulls the settings stored in the cloud into the codespace at the point of creation, but any updates you make to the settings in the codespace are not propagated to the cloud, so are not reflected in any other codespaces. Equally, any updates you make to your settings elsewhere are not reflected in your codespace.
+- If you open a codespace in the {% data variables.product.prodname_vscode_shortname %} desktop application, Settings Sync remains enabled in the codespace if you have previously enabled it for the application. Any updates you make to your settings are pushed to cloud, so are reflected in new codespaces and any existing codespaces in which Settings Sync is enabled. If you make updates to your settings in other {% data variables.product.prodname_vscode_shortname %} instances where Settings Sync is enabled, these updates are reflected in your codespace.
 
-For more information, see the [Settings Sync guide](https://code.visualstudio.com/docs/editor/settings-sync) in the {% data variables.product.prodname_vscode_shortname %} documentation.
+If you're working in a codespace where Settings Sync is disabled, you can enable Settings Sync to push changes you have made to your settings to the cloud, or pull in the latest changes to your settings you have made elsewhere.
+
+### Enabling Settings Sync
+
+{% note %}
+
+**Note:** You should only enable Settings Sync in codespaces created from repositories you trust. For more information, see "[Security in {% data variables.product.prodname_github_codespaces %}](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)."
+
+{% endnote %}
+
+1. In {% data variables.product.prodname_vscode_shortname %}, at the bottom of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Turn on Settings Sync…**
+1. In the dropdown, select which settings you want to sync.
+
+   ![Screenshot of the Setting Sync options](/assets/images/help/codespaces/codespaces-manage-settings-sync.png)
+
+1. Click **Sign in & Turn on**, then select the account to which you want your settings to be synced.
+
+When you have signed in, the {% data variables.product.prodname_vscode_shortname %} instance you're working in will immediately be updated to display the latest synced settings.
+
+### Disabling Settings Sync
+
+{% data reusables.codespaces.disabling-settings-sync %}
 
 ## Dotfiles
 
@@ -87,7 +109,7 @@ You can use your selected dotfiles repository to personalize your {% data variab
 
 You can add further script, preferences, configuration files to your dotfiles repository or edit existing files whenever you want. Changes to settings will only be picked up by new codespaces.
 
-If your codespace fails to pick up configuration settings from dotfiles, see "[Troubleshooting dotfiles for {% data variables.product.prodname_github_codespaces %}](/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces)."
+If your codespace fails to pick up configuration settings from dotfiles, see "[Troubleshooting personalization options for {% data variables.product.prodname_github_codespaces %}](/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces#troubleshooting-dotfiles)."
 
 ## Other available settings
 

content/codespaces/getting-started/quickstart.md

@@ -93,7 +93,9 @@ When you connect to a codespace using the browser, or the {% data variables.prod
 
    ![Select the fairyfloss theme](/assets/images/help/codespaces/fairyfloss.png)
 
-If you are using a codespace in the browser, or in the {% data variables.product.prodname_vscode %} desktop application, and you have [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) turned on, any changes you make to your editor setup in the current codespace, such as changing your theme or keyboard bindings, are automatically synced to any instances of {% data variables.product.prodname_vscode %} that are signed into your {% data variables.product.prodname_dotcom %} account and to any other codespaces you create.
+### About Settings Sync
+
+You can enable Settings Sync to sync extensions and other settings across devices and instances of {% data variables.product.prodname_vscode_shortname %}. {% data reusables.codespaces.about-settings-sync %} For more information, see "[Personalizing {% data variables.product.prodname_github_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#settings-sync)."
 
 ## Next steps
 

content/codespaces/troubleshooting/index.md

@@ -16,7 +16,7 @@ children:
   - /troubleshooting-creation-and-deletion-of-codespaces
   - /troubleshooting-your-connection-to-github-codespaces
   - /troubleshooting-prebuilds
-  - /troubleshooting-dotfiles-for-codespaces
+  - /troubleshooting-personalization-for-codespaces
   - /troubleshooting-port-forwarding-for-github-codespaces
   - /troubleshooting-github-codespaces-clients
   - /troubleshooting-gpg-verification-for-github-codespaces

content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md

@@ -1,16 +1,22 @@
 ---
-title: Troubleshooting dotfiles for GitHub Codespaces
+title: Troubleshooting personalization options for GitHub Codespaces
 allowTitleToDifferFromFilename: true
-intro: Troubleshooting steps for common dotfiles issues.
+intro: Troubleshooting steps for common issues with dotfiles and Settings Sync.
 versions:
   fpt: '*'
   ghec: '*'
 type: reference
 topics:
   - Codespaces
-shortTitle: Dotfiles
+shortTitle: Personalization
+redirect_from:
+  - /codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces
 ---
 
+You can personalize {% data variables.product.prodname_github_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_github_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account)."
+
+## Troubleshooting dotfiles
+
 If your codespace fails to pick up configuration settings from dotfiles, you should work through the following debugging steps.
 
 1. Enable dotfiles by selecting **Automatically install dotfiles** in [your personal {% data variables.product.prodname_github_codespaces %} settings](https://github.com/settings/codespaces).
@@ -23,3 +29,7 @@ If your codespace fails to pick up configuration settings from dotfiles, you sho
 1. Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. For more information, see [Creation logs](/codespaces/troubleshooting/codespaces-logs#creation-logs).
 
 If the configuration from your dotfiles is correctly picked up, but part of the configuration is incompatible with codespaces, use the `$CODESPACES` environment variable to add conditional logic for codespace-specific configuration settings.
+
+## Troubleshooting Settings Sync
+
+{% data reusables.codespaces.disabling-settings-sync %}

data/reusables/codespaces/about-settings-sync.md

@@ -0,0 +1,3 @@
+When you enable Settings Sync in an instance of {% data variables.product.prodname_vscode_shortname %}, such as the {% data variables.product.prodname_vscode_shortname %} desktop application on your laptop, your settings for that instance are stored in the cloud. From the cloud, the settings are pulled into all new codespaces at the point of creation, and continuously synced to any existing codespaces in which Settings Sync is enabled. 
+
+Whether Settings Sync is enabled by default in a codespace depends on your existing settings and on whether you open the codespace in the browser or in the {% data variables.product.prodname_vscode_shortname %} desktop application.

data/reusables/codespaces/disabling-settings-sync.md

@@ -0,0 +1,15 @@
+You can disable Settings Sync to stop syncing settings to and from an instance of {% data variables.product.prodname_vscode_shortname %}.
+
+By default, when you disable Settings Sync, new codespaces continue to use the settings cached from the last time your settings were pushed to the cloud. If your codespaces are still being created with cached settings, and you want to return to using the default {% data variables.product.prodname_vscode_shortname %} settings in your codespaces, you can clear the cache in the cloud when you disable Settings Sync.
+
+1. If Settings Sync is currently disabled in your instance of {% data variables.product.prodname_vscode_shortname %}, you must first enable it. For instructions, see "[Enabling Settings Sync](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#enabling-settings-sync)."
+1. At the bottom of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is On**.
+1. In the dropdown, click **Settings Sync: Turn Off**.
+
+   ![Screenshot of the Settings Sync Turn Off option in VS Code](/assets/images/help/codespaces/settings-sync-turn-off.png)
+
+1. To clear your cached settings, in the dialog, select **Turn off sync on all your devices and clear the data from the cloud**.
+
+   ![Screenshot of the Turn Off Settings Sync dialog](/assets/images/help/codespaces/turn-off-sync-dialog.png)
+
+1. Click **Turn off**.