From a0042639cc2cb970885225950632ece5cfd24a78 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Fri, 7 Jun 2024 15:13:29 +0100 Subject: [PATCH] Copilot: improve scannability of config articles (#50979) Co-authored-by: Sarah Edwards --- ...ng-github-copilot-settings-on-githubcom.md | 20 --------- ...al-github-copilot-settings-on-githubcom.md | 42 +++++++++++++++++++ .../configuring-github-copilot/index.md | 2 +- content/copilot/index.md | 3 +- ...that-matches-github-copilot-suggestions.md | 4 +- ...copilot-code-suggestions-in-your-editor.md | 8 ++-- .../copilot/code-examples-limitations.md | 2 +- data/reusables/copilot/dotcom-settings.md | 28 +------------ data/reusables/copilot/signup-procedure.md | 2 +- data/reusables/gated-features/copilot.md | 4 +- .../user-settings/access_settings.md | 2 +- 11 files changed, 55 insertions(+), 62 deletions(-) delete mode 100644 content/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom.md create mode 100644 content/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom.md diff --git a/content/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom.md b/content/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom.md deleted file mode 100644 index 42e16e960840..000000000000 --- a/content/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Configuring GitHub Copilot settings on GitHub.com -shortTitle: Copilot on GitHub.com -intro: 'You can change your personal settings on {% data variables.product.prodname_dotcom_the_website %} to configure {% data variables.product.prodname_copilot %}''s behavior. This affects how {% data variables.product.prodname_copilot %} functions in any supported IDE you use.' -product: '{% data reusables.gated-features.copilot %}' -permissions: 'People with individual {% data variables.product.prodname_copilot %} subscriptions can configure their settings on {% data variables.product.prodname_dotcom_the_website %}.' -topics: - - Copilot -versions: - feature: copilot -redirect_from: - - /github/copilot/about-github-copilot-telemetry - - /github/copilot/github-copilot-telemetry-terms ---- - -## About {% data variables.product.prodname_copilot %} settings on {% data variables.product.prodname_dotcom_the_website %} - -In addition to the configuration for the {% data variables.product.prodname_copilot %} plugin in your supported IDE, you can configure settings for {% data variables.product.prodname_copilot %} on {% data variables.product.prodname_dotcom_the_website %}. The settings apply wherever you use {% data variables.product.prodname_copilot %}. - -{% data reusables.copilot.dotcom-settings %} diff --git a/content/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom.md b/content/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom.md new file mode 100644 index 000000000000..2bd034efabc1 --- /dev/null +++ b/content/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom.md @@ -0,0 +1,42 @@ +--- +title: Configuring your personal GitHub Copilot settings on GitHub.com +shortTitle: Copilot on GitHub.com +intro: 'Find out how to change your personal settings on {% data variables.product.prodname_dotcom_the_website %} to configure {% data variables.product.prodname_copilot %}''s behavior.' +product: '{% data variables.product.prodname_copilot_for_individuals %}' +topics: + - Copilot +versions: + feature: copilot +redirect_from: + - /copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom + - /github/copilot/about-github-copilot-telemetry + - /github/copilot/github-copilot-telemetry-terms +--- + +## About {% data variables.product.prodname_copilot %} settings on {% data variables.product.prodname_dotcom_the_website %} + +In addition to the configuration for the {% data variables.product.prodname_copilot %} plugin in your supported IDE, you can configure settings for {% data variables.product.prodname_copilot %} on {% data variables.product.prodname_dotcom_the_website %}. The settings apply wherever you use {% data variables.product.prodname_copilot %}. + +## Enabling or disabling suggestions matching public code + +> [!NOTE] If you are a member of an organization on {% data variables.product.prodname_ghe_cloud %} who has been assigned a {% data variables.product.prodname_copilot %} seat through your organization, you will not be able to configure suggestions matching public code in your personal account settings. Your setting for suggestions matching public code will be inherited from your organization or enterprise. + +Your personal settings for {% data variables.product.prodname_copilot %} include an option to either allow or block code completion suggestions that match publicly available code. If you choose to block suggestions matching public code, {% data variables.product.prodname_copilot %} checks code completion suggestions with their surrounding code of about 150 characters against public code on {% data variables.product.prodname_dotcom %}. If there is a match, or a near match, the suggestion is not shown to you. + +If you choose to allow suggestions matching public code, and you accept a suggestion for which one or more matches were found, you can click through from an entry in the {% data variables.product.prodname_copilot %} log to view a list of references on {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions)." + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.copilot-settings %} +1. Under **Suggestions matching public code**, select the dropdown menu, then click **Allow** to allow suggestions matching public code, or **Block** to block suggestions matching public code. +{% data reusables.copilot.save-settings %} + +{% ifversion fpt %} + +## Enabling or disabling prompt and suggestion collection + +You can choose whether your prompts and {% data variables.product.prodname_copilot_short %}'s suggestions are collected and retained by {% data variables.product.prodname_dotcom %}, and further processed and shared with Microsoft. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq-privacy-copilot-for-business). + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.copilot-settings %} +1. To allow or prevent {% data variables.product.prodname_dotcom %} using your data, select or deselect **Allow {% data variables.product.prodname_dotcom %} to use my code snippets from the code editor for product improvements**. +{% data reusables.copilot.save-settings %}{% endif %} diff --git a/content/copilot/configuring-github-copilot/index.md b/content/copilot/configuring-github-copilot/index.md index a08f86f528dc..7b578036b7c3 100644 --- a/content/copilot/configuring-github-copilot/index.md +++ b/content/copilot/configuring-github-copilot/index.md @@ -7,7 +7,7 @@ versions: topics: - Copilot children: - - /configuring-github-copilot-settings-on-githubcom + - /configuring-your-personal-github-copilot-settings-on-githubcom - /configuring-github-copilot-in-your-environment - /installing-the-github-copilot-extension-in-your-environment - /configuring-network-settings-for-github-copilot diff --git a/content/copilot/index.md b/content/copilot/index.md index bf0e1e66be23..583ada7c3e14 100644 --- a/content/copilot/index.md +++ b/content/copilot/index.md @@ -15,7 +15,7 @@ featuredLinks: popular: - /billing/managing-billing-for-github-copilot/about-billing-for-github-copilot - /copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment - - /copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom + - /copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom layout: product-landing versions: feature: copilot @@ -34,4 +34,3 @@ children: topics: - Copilot --- - diff --git a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md b/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md index 96b848f49546..2ac8be478cd0 100644 --- a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md +++ b/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md @@ -18,7 +18,7 @@ versions: ## About code referencing in {% data variables.product.prodname_copilot %} -You can opt to allow {% data variables.product.prodname_copilot %} to suggest code completions that match publicly available code on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom#enabling-or-disabling-duplication-detection)." +You can opt to allow {% data variables.product.prodname_copilot %} to suggest code completions that match publicly available code on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code)." If you have allowed suggestions that match public code, {% data variables.product.prodname_copilot %} can provide you with details about the matching code when you accept such suggestions. This feature is called code referencing. It is currently only available in {% data variables.product.prodname_vscode %}. @@ -42,7 +42,7 @@ The linked web page includes details of any license identified for the repositor ## Using code referencing in {% data variables.product.prodname_vscode %} -To use code referencing you must have allowed suggestions matching public code. For more information, see "[Enabling or disabling duplication detection](/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom#enabling-or-disabling-duplication-detection)." +To use code referencing you must have allowed suggestions matching public code. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code)." You can access code references from one of the {% data variables.product.prodname_copilot %} logs in {% data variables.product.prodname_vscode %}. diff --git a/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md b/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md index e02c68d96d58..bafe84329348 100644 --- a/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md +++ b/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md @@ -76,7 +76,7 @@ void process () { {% data variables.product.prodname_copilot %} will attempt to match the context and style of your code. You can always edit the suggested code. > [!TIP] -> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom#enabling-or-disabling-duplication-detection)." +> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code)." ## Showing alternative suggestions @@ -181,7 +181,7 @@ var doc = XDocument.Load("index.xhml"); {% data variables.product.prodname_copilot %} will suggest an implementation of the function. {% data reusables.copilot.accept-suggestion %} > [!TIP] -> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom#enabling-or-disabling-duplication-detection)." +> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code)." ## Showing alternative suggestions @@ -240,7 +240,7 @@ You can also describe something you want to do using natural language within a c {% data variables.product.prodname_copilot %} will automatically suggest code. {% data reusables.copilot.accept-suggestion %} > [!TIP] -> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom#enabling-or-disabling-duplication-detection)." +> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code)." ## Showing alternative suggestions @@ -372,7 +372,7 @@ SELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red] {% data variables.product.prodname_copilot %} will automatically suggest code. {% data reusables.copilot.accept-suggestion %} > [!TIP] - > If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom#enabling-or-disabling-duplication-detection)." + > If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code)." ## Showing alternative suggestions diff --git a/data/reusables/copilot/code-examples-limitations.md b/data/reusables/copilot/code-examples-limitations.md index 22ef75ed902d..f007a693d6e1 100644 --- a/data/reusables/copilot/code-examples-limitations.md +++ b/data/reusables/copilot/code-examples-limitations.md @@ -1,5 +1,5 @@ {% note %} -**Note:** If you have duplication detection enabled for {% data variables.product.prodname_copilot %}, you may receive limited suggestions, or no suggestions, when using the code examples provided. As an alternative, you can start by typing your own code to see suggestions from {% data variables.product.prodname_copilot %}. For more information on duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-on-githubcom#enabling-or-disabling-duplication-detection)." +**Note:** If you have duplication detection enabled for {% data variables.product.prodname_copilot %}, you may receive limited suggestions, or no suggestions, when using the code examples provided. As an alternative, you can start by typing your own code to see suggestions from {% data variables.product.prodname_copilot %}. For more information on duplication detection, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code)." {% endnote %} diff --git a/data/reusables/copilot/dotcom-settings.md b/data/reusables/copilot/dotcom-settings.md index 5384e889fa53..f1bf68b43e3c 100644 --- a/data/reusables/copilot/dotcom-settings.md +++ b/data/reusables/copilot/dotcom-settings.md @@ -1,29 +1,3 @@ ## Configuring {% data variables.product.prodname_copilot %} settings on {% data variables.product.prodname_dotcom_the_website %} -Before you can start using {% data variables.product.prodname_copilot %}, you will need to set up a free trial or subscription. For more information about setting up a trial or subscription for your personal account, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user)." For more information about setting up a subscription for your organization{% ifversion ghec%} or enterprise{% endif %}, see {% ifversion ghec %}"[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise)."{% else %}"[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization)."{% endif %} - -Once you have an active {% data variables.product.prodname_copilot_for_individuals %} trial or subscription, you can adjust {% data variables.product.prodname_copilot %} settings for your personal account on {% data variables.product.prodname_dotcom %} in the [{% data variables.product.prodname_copilot %} settings](https://github.com/settings/copilot). The settings apply anywhere that you use {% data variables.product.prodname_copilot %}. You can configure the suggestions that {% data variables.product.prodname_copilot %} offers and how {% data variables.product.company_short %} uses your telemetry data. - -### Enabling or disabling duplication detection - -{% data reusables.copilot.duplication-setting-org %} - -Your personal settings for {% data variables.product.prodname_copilot %} include an option to either allow or block code completion suggestions that match publicly available code. If you choose to block suggestions matching public code, {% data variables.product.prodname_copilot %} checks code completion suggestions with their surrounding code of about 150 characters against public code on {% data variables.product.prodname_dotcom %}. If there is a match, or a near match, the suggestion is not shown to you. - -If you choose to allow suggestions matching public code, and you accept a suggestion for which one or more matches were found, you can click through from an entry in the {% data variables.product.prodname_copilot %} log to view a list of references on {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions)." - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.copilot-settings %} -1. Under **Suggestions matching public code**, select the dropdown menu, then click **Allow** to allow suggestions matching public code, or **Block** to block suggestions matching public code. -{% data reusables.copilot.save-settings %} - -{% ifversion fpt %} - -### Enabling or disabling prompt and suggestion collection - -You can choose whether your prompts and suggestions from your code editor are collected and retained by {% data variables.product.prodname_dotcom %} and further processed and shared with Microsoft and by adjusting your user settings. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq-privacy-copilot-for-business). - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.copilot-settings %} -1. To allow or prevent {% data variables.product.prodname_dotcom %} using your data, select or deselect **Allow {% data variables.product.prodname_dotcom %} to use my code snippets from the code editor for product improvements**. -{% data reusables.copilot.save-settings %}{% endif %} +If you are using a {% data variables.product.prodname_copilot_for_individuals %} subscription, you can choose to allow or block code completion suggestions that match publicly available code. {% ifversion fpt %}You can also allow or block the collection and retention of the prompts you enter and {% data variables.product.prodname_copilot_short %}'s suggestions.{% endif %} You configure this in your personal settings on {% data variables.product.prodname_dotcom_the_website %}. See "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom)." diff --git a/data/reusables/copilot/signup-procedure.md b/data/reusables/copilot/signup-procedure.md index 0d6bd0f20d77..e099f684ed72 100644 --- a/data/reusables/copilot/signup-procedure.md +++ b/data/reusables/copilot/signup-procedure.md @@ -7,4 +7,4 @@ 1. Follow the steps to enter and confirm your payment details, then click **Submit**. 1. Select your preferences, then click **Save and complete setup**. - You can change these preferences at a later time by returning to your {% data variables.product.prodname_copilot %} settings. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment?tool=vscode#configuring-github-copilot-settings-on-githubcom)." + You can change these preferences at a later time by returning to your {% data variables.product.prodname_copilot %} settings. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment?tool=vscode#configuring-your-personal-github-copilot-settings-on-githubcom)." diff --git a/data/reusables/gated-features/copilot.md b/data/reusables/gated-features/copilot.md index a25199984794..f918c8fa5417 100644 --- a/data/reusables/gated-features/copilot.md +++ b/data/reusables/gated-features/copilot.md @@ -1,3 +1 @@ -{% data variables.product.prodname_copilot %} can be managed through personal accounts with {% data variables.product.prodname_copilot_for_individuals %}{% ifversion ghec %}, {% elsif fpt %} or {% endif %}through organization{% ifversion ghec %} or enterprise{% endif %} accounts with {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %}, or through enterprise accounts with {% data variables.product.prodname_copilot_enterprise %}{% endif %}.

- -{% data variables.product.prodname_copilot %} is free to use for verified students, teachers, and maintainers of popular open source projects. {% ifversion fpt %}If you are not a student, teacher, or maintainer of a popular open source project, you can try {% data variables.product.prodname_copilot %} for free with a one-time {% data reusables.copilot.trial-period %}-day trial. After the free trial, you will need a paid subscription for continued use.{% endif %} For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." +{% data variables.product.prodname_copilot_for_individuals %}{% ifversion ghec %}, {% elsif fpt %} or {% endif %} {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %}, or {% data variables.product.prodname_copilot_enterprise %}{% endif %}. diff --git a/data/reusables/user-settings/access_settings.md b/data/reusables/user-settings/access_settings.md index 1d5a4c89241d..aedd400f0f82 100644 --- a/data/reusables/user-settings/access_settings.md +++ b/data/reusables/user-settings/access_settings.md @@ -1,4 +1,4 @@ -1. In the upper-right corner of any page, click your profile photo, then click **Settings**. +1. In the upper-right corner of any page on {% data variables.product.prodname_dotcom %}, click your profile photo, then click **Settings**. {% ifversion global-nav-update %}