From a6b51ea01e008cf23de24e133083bde39851998b Mon Sep 17 00:00:00 2001 From: Amy Unger Date: Wed, 29 Jun 2022 13:45:35 -0500 Subject: [PATCH 1/3] Ensure folks know to enable dotfiles while troubleshooting --- .../troubleshooting-dotfiles-for-codespaces.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md index b964dbc0d551..ccf6e027e245 100644 --- a/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md @@ -14,9 +14,11 @@ shortTitle: Dotfiles If your codespace fails to pick up configuration settings from dotfiles, you should work through the following debugging steps. 1. Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles. -2. Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. +2. Enable dotfiles by checking "Automatically install dotfiles" in [your personal Codespaces settings](https://github.com/settings/codespaces). +![codespaces-dotfiles-setting](https://user-images.githubusercontent.com/1014482/176512385-4f2ca981-c57c-41db-bcd6-1d9b60f7285e.png) +3. Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - If your dotfiles were cloned, try manually re-running your install script to verify that it is executable. - If your dotfiles were not cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them. -3. Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. For more information, see [Creation logs](/codespaces/troubleshooting/codespaces-logs#creation-logs). +4. 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. From 5f97b5dcb95fd4ce85c39cb31a4555d301ac9669 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Fri, 1 Jul 2022 12:13:12 +0100 Subject: [PATCH 2/3] Update content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md --- .../troubleshooting/troubleshooting-dotfiles-for-codespaces.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md index ccf6e027e245..15f57db93c97 100644 --- a/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md @@ -14,7 +14,7 @@ shortTitle: Dotfiles If your codespace fails to pick up configuration settings from dotfiles, you should work through the following debugging steps. 1. Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles. -2. Enable dotfiles by checking "Automatically install dotfiles" in [your personal Codespaces settings](https://github.com/settings/codespaces). +2. Enable dotfiles by selecting **Automatically install dotfiles** in [your personal Codespaces settings](https://github.com/settings/codespaces). ![codespaces-dotfiles-setting](https://user-images.githubusercontent.com/1014482/176512385-4f2ca981-c57c-41db-bcd6-1d9b60f7285e.png) 3. Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - If your dotfiles were cloned, try manually re-running your install script to verify that it is executable. From 9755e893904c319f88de3c0eb9dd4396894a128c Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 11 Jul 2022 14:24:03 +0100 Subject: [PATCH 3/3] Put the image file in the repo --- .../troubleshooting-dotfiles-for-codespaces.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md index 15f57db93c97..b3952bd52f31 100644 --- a/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces.md @@ -15,10 +15,12 @@ If your codespace fails to pick up configuration settings from dotfiles, you sho 1. Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles. 2. Enable dotfiles by selecting **Automatically install dotfiles** in [your personal Codespaces settings](https://github.com/settings/codespaces). -![codespaces-dotfiles-setting](https://user-images.githubusercontent.com/1014482/176512385-4f2ca981-c57c-41db-bcd6-1d9b60f7285e.png) + + ![The 'Automatically install dotfiles' option](/assets/images/help/codespaces/automatically-install-dotfiles.png) + 3. Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned. - - If your dotfiles were cloned, try manually re-running your install script to verify that it is executable. - - If your dotfiles were not cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them. + - If your dotfiles were cloned, try manually re-running your install script to verify that it is executable. + - If your dotfiles were not cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them. 4. 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.