diff --git a/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md
index 189f12aca9a5..48264e23314e 100644
--- a/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md
+++ b/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md
@@ -79,8 +79,8 @@ If you change from **user ownership** to **organization ownership**, existing co
{% data reusables.organizations.click-codespaces %}
{% data reusables.organizations.click-general %}
1. On the {% data variables.product.prodname_codespaces %} settings page, under "Codespace ownership," select the setting you want for your organization:
- * **Organization ownership**: Codespaces can be owned and paid for by your organization.
- * **User ownership**: Codespaces are always owned and paid for by the user who creates the codespace.
+ * **Organization ownership:** Codespaces can be owned and paid for by your organization.
+ * **User ownership:** Codespaces are always owned and paid for by the user who creates the codespace.
1. Optionally, under "Codespaces access," review the members and collaborators for whom you have enabled {% data variables.product.prodname_codespaces %}. These are the only users who can create codespaces that your organization pays for. See "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization)."
diff --git a/content/codespaces/reference/security-in-github-codespaces.md b/content/codespaces/reference/security-in-github-codespaces.md
index 56915d838138..d8c9bec7f8c4 100644
--- a/content/codespaces/reference/security-in-github-codespaces.md
+++ b/content/codespaces/reference/security-in-github-codespaces.md
@@ -42,9 +42,9 @@ Every time a codespace is created or restarted, it's assigned a new {% data vari
The token's scope will vary depending on the access you have to the repository where the codespace was created:
-* **If you have write access to the repository**: The token will be scoped for read/write access to the repository.
-* **If you only have read access to the repository**: The token will only allow the code to be cloned from the source repository. If you make a commit in the codespace, or push a new branch, {% data variables.product.prodname_github_codespaces %} automatically creates a fork of the repository, or links the codespace to an existing fork if you already have one for the upstream repository. The token is updated to have read and write access to the fork. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#about-automatic-forking)."
-* **If you've authorized your codespace to access other repositories**: The token will be scoped for read or read/write access to the source repository and to any other repositories to which you've authorized access. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces#authorizing-requested-permissions)."
+* **If you have write access to the repository:** The token will be scoped for read/write access to the repository.
+* **If you only have read access to the repository:** The token will only allow the code to be cloned from the source repository. If you make a commit in the codespace, or push a new branch, {% data variables.product.prodname_github_codespaces %} automatically creates a fork of the repository, or links the codespace to an existing fork if you already have one for the upstream repository. The token is updated to have read and write access to the fork. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#about-automatic-forking)."
+* **If you've authorized your codespace to access other repositories:** The token will be scoped for read or read/write access to the source repository and to any other repositories to which you've authorized access. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces#authorizing-requested-permissions)."
### Codespace connections
@@ -58,11 +58,11 @@ If you need to connect to a service (such as a development web server) running w
Organization owners can restrict the ability to make forward ports available publicly or within the organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)."
-**Privately forwarded ports**: Are accessible on the internet, but only the codespace creator can access them, after authenticating to {% data variables.product.product_name %}.
+**Privately forwarded ports:** Are accessible on the internet, but only the codespace creator can access them, after authenticating to {% data variables.product.product_name %}.
-**Publicly forwarded ports within your organization**: Are accessible on the internet, but only to members of the same organization as the codespace, after authenticating to {% data variables.product.product_name %}.
+**Publicly forwarded ports within your organization:** Are accessible on the internet, but only to members of the same organization as the codespace, after authenticating to {% data variables.product.product_name %}.
-**Publicly forwarded ports**: Are accessible on the internet, and anyone on the internet can access them. No authentication is needed to access public forwarded ports.
+**Publicly forwarded ports:** Are accessible on the internet, and anyone on the internet can access them. No authentication is needed to access public forwarded ports.
All forwarded ports are private by default, which means that you will need to authenticate before you can access the port. Access to a codespace's private forwarded ports is controlled by authentication cookies with a 3-hour expiry period. When the cookie expires, you will need to reauthenticate.
diff --git a/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md b/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md
index 33f5591063d0..fb61f7f58a0c 100644
--- a/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md
+++ b/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md
@@ -95,13 +95,13 @@ During development, you can visit any page on `http://localhost:4000` and add `?
If your text or code example includes content between curly brackets (`{` and `}`), you need to wrap it between {% raw %}
and {% raw %}
tags to disable Liquid processing for that section. For example:
-* **Use**:
+* **Use:**
GITHUB_TOKEN: {% raw %}${% raw %}{{ secrets.GITHUB_TOKEN }}{% endraw %}{% endraw %}-* **Avoid**: +* **Avoid:**
GITHUB_TOKEN: ${% raw %}${{ secrets.GITHUB_TOKEN }}${% endraw %} diff --git a/content/contributing/style-guide-and-content-model/style-guide.md b/content/contributing/style-guide-and-content-model/style-guide.md index b70c30597319..e09ad94fb15c 100644 --- a/content/contributing/style-guide-and-content-model/style-guide.md +++ b/content/contributing/style-guide-and-content-model/style-guide.md @@ -29,10 +29,10 @@ We document each of the events that may appear in the audit logs for each type o When writing the description for an audit log event, describe the event that took place in a way that applies to all versions, using past tense and passive voice. Do not begin the sentence with phrases that are already implied by the context of the article, such as "Triggered by." -* **Use**: The visibility of a repository was changed. -* **Use**: Secret scanning was enabled for all new repositories. -* **Avoid**: An organization owner disabled a two-factor authentication requirement for the organization. -* **Avoid**: Triggered when a user updates which repositories a codespace can access. +* **Use:** The visibility of a repository was changed. +* **Use:** Secret scanning was enabled for all new repositories. +* **Avoid:** An organization owner disabled a two-factor authentication requirement for the organization. +* **Avoid:** Triggered when a user updates which repositories a codespace can access. ## Alerts @@ -175,13 +175,13 @@ Within code blocks: ``` * If your code example includes `{` or `}` that should render, wrap that section in{% raw %}
{% endraw %}
to disable Liquid processing for that section. - * **Use**: + * **Use:**GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}- * **Avoid**: + * **Avoid:**GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -1031,9 +1031,9 @@ A release note for a security fix answers the following questions. #### Examples of release notes for security fixes -* > **MEDIUM**: An attacker could cause unbounded resource exhaustion on the instance by making parallel requests to the Markdown REST API. To mitigate this issue, {% data variables.product.company_short %} has updated [CommonMarker](https://github.com/gjtorikian/commonmarker). {% data variables.product.company_short %} has requested CVE ID [CVE-2022-39209](https://nvd.nist.gov/vuln/detail/CVE-2022-39209) for this vulnerability. +* > **MEDIUM:** An attacker could cause unbounded resource exhaustion on the instance by making parallel requests to the Markdown REST API. To mitigate this issue, {% data variables.product.company_short %} has updated [CommonMarker](https://github.com/gjtorikian/commonmarker). {% data variables.product.company_short %} has requested CVE ID [CVE-2022-39209](https://nvd.nist.gov/vuln/detail/CVE-2022-39209) for this vulnerability. -* > **MEDIUM**: An attacker could embed dangerous links in the instance's web UI because pull request preview links did not properly sanitize URLs. This vulnerability was reported via the [{% data variables.product.company_short %} Bug Bounty program](https://bounty.github.com). +* > **MEDIUM:** An attacker could embed dangerous links in the instance's web UI because pull request preview links did not properly sanitize URLs. This vulnerability was reported via the [{% data variables.product.company_short %} Bug Bounty program](https://bounty.github.com). #### Base image and package updates @@ -1147,7 +1147,7 @@ A release note for a deprecation answers the following questions. #### Examples of release notes for deprecations -* > **Upcoming deprecation**: In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell. +* > **Upcoming deprecation:** In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell. * > Commit comments, which are comments that users add directly to a commit outside of a pull request, no longer appear in the pull request timeline. Users could not reply to or resolve these comments. The Timeline events REST API and the GraphQL API's `PullRequest` object also no longer return commit comments. @@ -1175,7 +1175,7 @@ A release note for a feature that is closing down answers the following question #### Examples of release notes for features that are closing down -* > **Closing down**: In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell. +* > **Closing down:** In {% data variables.product.prodname_ghe_server %} 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell. * > Commit comments, which are comments that users add directly to a commit outside of a pull request, no longer appear in the pull request timeline. Users could not reply to or resolve these comments. The Timeline events REST API and the GraphQL API's `PullRequest` object also no longer return commit comments. @@ -1201,7 +1201,7 @@ A release note for a retired feature answers the following questions. #### Examples of release notes for retired features -* > **Retired**: {% data variables.product.github %} no longer supports required workflows for {% data variables.product.prodname_actions %} in {% data variables.product.prodname_ghe_server %} 3.11 and later. Use repository rulesets instead. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)." +* > **Retired:** {% data variables.product.github %} no longer supports required workflows for {% data variables.product.prodname_actions %} in {% data variables.product.prodname_ghe_server %} 3.11 and later. Use repository rulesets instead. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)." {% endif %} diff --git a/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md index 94167af8ad49..e0fcea95b887 100644 --- a/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md @@ -45,24 +45,24 @@ Videos are broadly grouped into three categories: product overviews, feature vid ### Product overviews -* **Purpose**: Briefly explain what the product is, showcase the main functionality, and get people interested -* **Length**: Less than a minute -* **Possible audiences**: People who want to know if a feature is useful for their goals, people who are new to {% data variables.product.company_short %} and trying to understand what the products do -* **Possible locations in the docs**: Landing pages and guides +* **Purpose:** Briefly explain what the product is, showcase the main functionality, and get people interested +* **Length:** Less than a minute +* **Possible audiences:** People who want to know if a feature is useful for their goals, people who are new to {% data variables.product.company_short %} and trying to understand what the products do +* **Possible locations in the docs:** Landing pages and guides ### Feature videos -* **Purpose**: Supplement conceptual or procedural content -* **Length**: As short as possible, without exceeding five minutes. Break longer content into multiple shorter, focused videos -* **Possible audiences**: People who are learning about or how to use a feature -* **Possible locations in the docs**: Guides, conceptual articles, procedural articles +* **Purpose:** Supplement conceptual or procedural content +* **Length:** As short as possible, without exceeding five minutes. Break longer content into multiple shorter, focused videos +* **Possible audiences:** People who are learning about or how to use a feature +* **Possible locations in the docs:** Guides, conceptual articles, procedural articles ### Tutorials -* **Purpose**: Help novice users get going with a product, drive adoption, or explain complex functionalities -* **Length**: Individual videos should be five minutes or less. Complex topics can have a series of shorter videos spread across an article. Total length should be a maximum of 15 minutes -* **Possible audiences**: New users of features or products -* **Possible locations**: Guides +* **Purpose:** Help novice users get going with a product, drive adoption, or explain complex functionalities +* **Length:** Individual videos should be five minutes or less. Complex topics can have a series of shorter videos spread across an article. Total length should be a maximum of 15 minutes +* **Possible audiences:** New users of features or products +* **Possible locations:** Guides ## When to use videos diff --git a/content/copilot/building-copilot-extensions/about-building-copilot-extensions.md b/content/copilot/building-copilot-extensions/about-building-copilot-extensions.md index cbc46622b2ad..eca5460c8121 100644 --- a/content/copilot/building-copilot-extensions/about-building-copilot-extensions.md +++ b/content/copilot/building-copilot-extensions/about-building-copilot-extensions.md @@ -15,10 +15,10 @@ type: overview {% data variables.product.prodname_copilot_extensions_short %} are integrations that expand the functionality of {% data variables.product.prodname_copilot_chat_short %}, allowing developers to bring external tools, services, and custom behaviors into the Chat experience. You can use {% data variables.product.prodname_copilot_extensions_short %} to extend the capabilities of {% data variables.product.prodname_copilot_chat_short %} in a variety of ways, including: -* **Querying documentation**: A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to query a third-party documentation service to find information about a specific topic. -* **AI-assisted coding**: A {% data variables.product.prodname_copilot_extension_short %} can use a third-party AI model to provide code suggestions. -* **Data retrieval**: A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to query a third-party data service to retrieve information about a specific topic. -* **Action execution**: A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to execute a specific action, such as posting to a message board or updating a tracking item in an external system. +* **Querying documentation:** A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to query a third-party documentation service to find information about a specific topic. +* **AI-assisted coding:** A {% data variables.product.prodname_copilot_extension_short %} can use a third-party AI model to provide code suggestions. +* **Data retrieval:** A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to query a third-party data service to retrieve information about a specific topic. +* **Action execution:** A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to execute a specific action, such as posting to a message board or updating a tracking item in an external system. ## About building {% data variables.product.prodname_copilot_extensions %} @@ -57,13 +57,13 @@ For more information about skillsets, see "[AUTOTITLE](/copilot/building-copilot Before creating your own {% data variables.product.prodname_copilot_extension %} from scratch, you may want to explore an existing {% data variables.product.prodname_copilot_agent_short %}, then integrate it with a {% data variables.product.prodname_github_app %} to see how it works. {% data variables.product.company_short %} provides a few example {% data variables.product.prodname_copilot_agents_short %} that you can clone and use as the basis for your own {% data variables.product.prodname_copilot_extension %}: -* **Blackbeard**: A simple {% data variables.product.prodname_copilot_agent_short %} that responds to requests like a pirate, using {% data variables.product.prodname_copilot_short %}'s LLM API and special system prompts. It is a good starting point for learning how to build a {% data variables.product.prodname_copilot_extension %}. For more information, see the [Blackbeard {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/blackbeard-extension). -* **{% data variables.product.prodname_github_models %}**: A more complex {% data variables.product.prodname_copilot_agent_short %} that lets you ask about and interact with various LLMs listed on the {% data variables.product.prodname_marketplace %} from within {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [{% data variables.product.prodname_github_models %} {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/github-models-extension). +* **Blackbeard:** A simple {% data variables.product.prodname_copilot_agent_short %} that responds to requests like a pirate, using {% data variables.product.prodname_copilot_short %}'s LLM API and special system prompts. It is a good starting point for learning how to build a {% data variables.product.prodname_copilot_extension %}. For more information, see the [Blackbeard {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/blackbeard-extension). +* **{% data variables.product.prodname_github_models %}:** A more complex {% data variables.product.prodname_copilot_agent_short %} that lets you ask about and interact with various LLMs listed on the {% data variables.product.prodname_marketplace %} from within {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [{% data variables.product.prodname_github_models %} {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/github-models-extension). > [!NOTE] {% data variables.product.prodname_github_models %} are in {% data variables.release-phases.public_preview %} and subject to change. To request access, join the [waitlist](https://github.com/marketplace/models/waitlist). -* **Function calling**: an example agent written in Go that demonstrates function calling and confirmation dialogues. For more information, see the [Function calling extension](https://github.com/copilot-extensions/function-calling-extension). -* **RAG extension**: an example agent written in Go that demonstrates a simple implementation of retrieval augmented generation. For more information, see the [RAG extension](https://github.com/copilot-extensions/rag-extension). -* **Preview SDK**: An SDK that simplifies the process of building {% data variables.product.prodname_copilot_extensions %} by handling request verification, response formatting, and API interactions. It allows builders to focus on their extension's core functionality rather than boilerplate, by streamlining the integration of tools, APIs, and data sources into {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [Preview SDK](https://github.com/copilot-extensions/preview-sdk.js). +* **Function calling:** an example agent written in Go that demonstrates function calling and confirmation dialogues. For more information, see the [Function calling extension](https://github.com/copilot-extensions/function-calling-extension). +* **RAG extension:** an example agent written in Go that demonstrates a simple implementation of retrieval augmented generation. For more information, see the [RAG extension](https://github.com/copilot-extensions/rag-extension). +* **Preview SDK:** An SDK that simplifies the process of building {% data variables.product.prodname_copilot_extensions %} by handling request verification, response formatting, and API interactions. It allows builders to focus on their extension's core functionality rather than boilerplate, by streamlining the integration of tools, APIs, and data sources into {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [Preview SDK](https://github.com/copilot-extensions/preview-sdk.js). ## About building {% data variables.product.prodname_copilot_extensions_vsc %} diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md b/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md index 80b9a72b2bac..34e105ea4e11 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md +++ b/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md @@ -19,8 +19,8 @@ type: how_to Before you begin, make sure you have the following: -1. **A configured {% data variables.product.prodname_github_app %}**: You’ll need a {% data variables.product.prodname_github_app %} to act as the container for your skillset. If you haven’t already set one up, refer to "[AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension)" and "[AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension)". -1. **API endpoints**: You need one endpoint per skill. Each endpoint must: +1. **A configured {% data variables.product.prodname_github_app %}:** You’ll need a {% data variables.product.prodname_github_app %} to act as the container for your skillset. If you haven’t already set one up, refer to "[AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension)" and "[AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension)". +1. **API endpoints:** You need one endpoint per skill. Each endpoint must: * Accept POST requests with the `application/json` MIME type * Be able to verify the signature of requests from {% data variables.product.github %} to authenticate their origin and prevent unauthorized access * Be publicly accessible via HTTPS @@ -30,10 +30,10 @@ For more information about signature verification, see "[Verifying that payloads ## Configuration requirements Each skillset is defined within a {% data variables.product.prodname_github_app %}. A single{% data variables.product.prodname_github_app %} can contain up to five skills. Each individual skill needs: -* **Name**: A clear and descriptive name (for example, "Get Issues"). -* **Inference description**: A detailed explanation of what the skill does and when to use it (for example, "Searches for external issues matching specific criteria like status and labels"). -* **API endpoint**: A POST endpoint that accepts JSON requests. -* **JSON schema**: The structure of data your endpoint expects. +* **Name:** A clear and descriptive name (for example, "Get Issues"). +* **Inference description:** A detailed explanation of what the skill does and when to use it (for example, "Searches for external issues matching specific criteria like status and labels"). +* **API endpoint:** A POST endpoint that accepts JSON requests. +* **JSON schema:** The structure of data your endpoint expects. ### Example JSON schema diff --git a/content/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md b/content/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md index afc0ede58557..7db995f7936f 100644 --- a/content/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md +++ b/content/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md @@ -13,8 +13,8 @@ type: how_to When you build a {% data variables.product.prodname_copilot_extension_short %}, you have two options for the visibility of your {% data variables.product.prodname_github_app %}: -* **Public**: Any user or organization account with the link to your app's installation page can install it. Making your app public automatically creates a public installation page, but does not list the app on the {% data variables.product.prodname_marketplace %}. -* **Private**: Only the user or organization account that created the app can install it. +* **Public:** Any user or organization account with the link to your app's installation page can install it. Making your app public automatically creates a public installation page, but does not list the app on the {% data variables.product.prodname_marketplace %}. +* **Private:** Only the user or organization account that created the app can install it. If you make your app public, you can choose to publish it on the {% data variables.product.prodname_marketplace %}. @@ -25,8 +25,8 @@ If you make your app public, you can choose to publish it on the {% data variabl 1. At the bottom of the sidebar, select **{% octicon "code" aria-hidden="true" %} Developer settings**, then click **{% data variables.product.prodname_github_apps %}**. 1. In the "{% data variables.product.prodname_github_apps %}" section, next to the name of your {% data variables.product.prodname_copilot_extension_short %}, click **Edit**. 1. In the sidebar, click **Advanced**. At the bottom of the "Danger Zone" section, you will see one of two options: - * **Make public**: If you see the **Make public** option, your {% data variables.product.prodname_github_app %} is currently private, and can only be installed by the organization or user that created the app. You can click **Make public** to allow any other account with the link to your app's installation page to install your {% data variables.product.prodname_copilot_extension_short %}, or leave your settings as they are to keep your app private. - * **Make private**: If you see the **Make private** option, your {% data variables.product.prodname_github_app %} is currently public, and can be installed by any account with the link to your app's installation page. You can click **Make private** to only allow the organization or user that created the app to install it, or leave your settings as they are to keep your app public. + * **Make public:** If you see the **Make public** option, your {% data variables.product.prodname_github_app %} is currently private, and can only be installed by the organization or user that created the app. You can click **Make public** to allow any other account with the link to your app's installation page to install your {% data variables.product.prodname_copilot_extension_short %}, or leave your settings as they are to keep your app private. + * **Make private:** If you see the **Make private** option, your {% data variables.product.prodname_github_app %} is currently public, and can be installed by any account with the link to your app's installation page. You can click **Make private** to only allow the organization or user that created the app to install it, or leave your settings as they are to keep your app public. 1. Optionally, if your {% data variables.product.prodname_github_app %} is public, you can share the link to the installation page for your {% data variables.product.prodname_copilot_extension_short %}. In the sidebar, click **Public page** in the sidebar, then copy the link for your listing. ## Listing your {% data variables.product.prodname_copilot_extension_short %} on the {% data variables.product.prodname_marketplace %} diff --git a/content/copilot/building-copilot-extensions/setting-up-copilot-extensions.md b/content/copilot/building-copilot-extensions/setting-up-copilot-extensions.md index bac3cb166ba2..882c65254cc8 100644 --- a/content/copilot/building-copilot-extensions/setting-up-copilot-extensions.md +++ b/content/copilot/building-copilot-extensions/setting-up-copilot-extensions.md @@ -56,8 +56,8 @@ To create a {% data variables.product.prodname_copilot_extension_short %}, you n ## 6. Choose the availability of your {% data variables.product.prodname_copilot_extension_short %} Choose one of two visibility levels for your {% data variables.product.prodname_copilot_extension_short %}: -* **Public**: Any user or organization account with the installation page link for the extension can install it. -* **Private**: Only the user or organization account that created the extension can install it. +* **Public:** Any user or organization account with the installation page link for the extension can install it. +* **Private:** Only the user or organization account that created the extension can install it. If you make your {% data variables.product.prodname_copilot_extension_short %} public, you can then choose to list it on the {% data variables.product.prodname_marketplace %}. @@ -94,8 +94,8 @@ To create a {% data variables.product.prodname_copilot_extension_short %}, you n ## 5. Choose the availability of your {% data variables.product.prodname_copilot_skillset_short %} Choose one of two visibility levels for your {% data variables.product.prodname_copilot_extension_short %}: -* **Public**: Any user or organization account with the installation page link for the extension can install it. -* **Private**: Only the user or organization account that created the extension can install it. +* **Public:** Any user or organization account with the installation page link for the extension can install it. +* **Private:** Only the user or organization account that created the extension can install it. If you make your {% data variables.product.prodname_copilot_extension_short %} public, you can then choose to list it on the {% data variables.product.prodname_marketplace %}. diff --git a/content/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot.md b/content/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot.md index 26b1bafd4e4a..3c12355fcd45 100644 --- a/content/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot.md +++ b/content/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot.md @@ -135,33 +135,33 @@ When you create a custom model, you can choose to allow {% data variables.produc ### What telemetry data is collected? -* **Prompts**: This includes all the information sent to the {% data variables.product.prodname_copilot %} language model by the {% data variables.product.prodname_copilot_short %} extension, including context from your open files. -* **Suggestions**: The code completion suggestions that {% data variables.product.prodname_copilot_short %} generates. -* **Code snippet**: A snapshot of the code 30 seconds after a suggestion is accepted, capturing how the suggestion was integrated into the codebase. This helps determine whether the suggestion was accepted as is or modified by the user before final integration. +* **Prompts:** This includes all the information sent to the {% data variables.product.prodname_copilot %} language model by the {% data variables.product.prodname_copilot_short %} extension, including context from your open files. +* **Suggestions:** The code completion suggestions that {% data variables.product.prodname_copilot_short %} generates. +* **Code snippet:** A snapshot of the code 30 seconds after a suggestion is accepted, capturing how the suggestion was integrated into the codebase. This helps determine whether the suggestion was accepted as is or modified by the user before final integration. ### How is telemetry data used? Telemetry data is primarily used to fine-tune the {% data variables.product.prodname_copilot_short %} custom model to better understand and predict your organization’s coding patterns. Specifically, it helps: -* **Enhance model accuracy**: By analyzing the collected telemetry, {% data variables.product.prodname_copilot_short %} refines your custom model to increase the relevance and accuracy of future coding suggestions. -* **Monitor performance**: Telemetry data allows {% data variables.product.company_short %} to monitor how well custom models are performing compared to the base model, enabling ongoing improvements. -* **Feedback loops**: The data helps {% data variables.product.company_short %} create feedback loops where the model learns from real-world usage, adapting to your specific coding environment over time. +* **Enhance model accuracy:** By analyzing the collected telemetry, {% data variables.product.prodname_copilot_short %} refines your custom model to increase the relevance and accuracy of future coding suggestions. +* **Monitor performance:** Telemetry data allows {% data variables.product.company_short %} to monitor how well custom models are performing compared to the base model, enabling ongoing improvements. +* **Feedback loops:** The data helps {% data variables.product.company_short %} create feedback loops where the model learns from real-world usage, adapting to your specific coding environment over time. ### Data storage and retention -* **Data storage**: All telemetry data collected is stored in the {% data variables.product.prodname_copilot_short %} Data Store, a secure and restricted environment. The data is encrypted and isolated to prevent unauthorized access. -* **Retention period**: Telemetry data is retained for a rolling 28-day period. After this period, the data is automatically deleted from {% data variables.product.company_short %}'s systems, ensuring that only recent and relevant data is used for model training and improvement. +* **Data storage:** All telemetry data collected is stored in the {% data variables.product.prodname_copilot_short %} Data Store, a secure and restricted environment. The data is encrypted and isolated to prevent unauthorized access. +* **Retention period:** Telemetry data is retained for a rolling 28-day period. After this period, the data is automatically deleted from {% data variables.product.company_short %}'s systems, ensuring that only recent and relevant data is used for model training and improvement. ### Privacy and data security {% data variables.product.company_short %} is committed to ensuring that your organization’s data remains private and secure. -* **Exclusive use**: The telemetry data collected from your organization is used exclusively for training your custom model and is never shared with other organizations or used to train other customers’ models. -* **Data leakage prevention**: {% data variables.product.company_short %} implements strict data isolation protocols to prevent cross-contamination between different organizations’ data. This means that your proprietary code and information are protected from exposure to other organizations or individuals. +* **Exclusive use:** The telemetry data collected from your organization is used exclusively for training your custom model and is never shared with other organizations or used to train other customers’ models. +* **Data leakage prevention:** {% data variables.product.company_short %} implements strict data isolation protocols to prevent cross-contamination between different organizations’ data. This means that your proprietary code and information are protected from exposure to other organizations or individuals. ### Important considerations -* **Opt-in for telemetry**: Participation in telemetry data collection is optional and controlled via your organization’s admin policies. Telemetry data is only collected when explicitly enabled for training custom models. -* **Potential risks**: Although {% data variables.product.company_short %} takes extensive measures to prevent data leakage, there are scenarios where sensitive data, such as internal links or names, could be included in the telemetry and subsequently used in training. We recommend reviewing and filtering the data you submit for training to minimize these risks. +* **Opt-in for telemetry:** Participation in telemetry data collection is optional and controlled via your organization’s admin policies. Telemetry data is only collected when explicitly enabled for training custom models. +* **Potential risks:** Although {% data variables.product.company_short %} takes extensive measures to prevent data leakage, there are scenarios where sensitive data, such as internal links or names, could be included in the telemetry and subsequently used in training. We recommend reviewing and filtering the data you submit for training to minimize these risks. For more details about our data-handling practices, see the [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) or review {% data variables.product.company_short %}’s [data protection agreement](https://github.com/customer-terms/github-data-protection-agreement). diff --git a/content/copilot/example-prompts-for-github-copilot-chat/refactoring-code/refactoring-to-implement-a-design-pattern.md b/content/copilot/example-prompts-for-github-copilot-chat/refactoring-code/refactoring-to-implement-a-design-pattern.md index 1779d99d4cbd..9cf6ebbd8a4f 100644 --- a/content/copilot/example-prompts-for-github-copilot-chat/refactoring-code/refactoring-to-implement-a-design-pattern.md +++ b/content/copilot/example-prompts-for-github-copilot-chat/refactoring-code/refactoring-to-implement-a-design-pattern.md @@ -60,9 +60,9 @@ getAge("Mario"); {% data variables.product.prodname_copilot_short %} suggests the following patterns: -* **Singleton pattern**: to ensure that there is only one instance of the `people` object. -* **Factory pattern**: to create a factory for creating `Person` objects. -* **Module pattern**: to encapsulate the `people` object and related functions within a module to avoid polluting the global namespace. +* **Singleton pattern:** to ensure that there is only one instance of the `people` object. +* **Factory pattern:** to create a factory for creating `Person` objects. +* **Module pattern:** to encapsulate the `people` object and related functions within a module to avoid polluting the global namespace. ## Example prompt 2 diff --git a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md b/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md index 9c0f1910da00..44beb7bc7054 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md +++ b/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md @@ -103,9 +103,9 @@ To configure language settings in the `github-copilot.xml` file, you must edit t The file is located in the following directory: -* **macOS**: `~/Library/Application Support/JetBrains//options/github-copilot.xml` -* **Windows**: `%APPDATA%\JetBrains\ \options\github-copilot.xml` -* **Linux**: `~/.config/JetBrains/ /options/github-copilot.xml` +* **macOS:** `~/Library/Application Support/JetBrains/ /options/github-copilot.xml` +* **Windows:** `%APPDATA%\JetBrains\ \options\github-copilot.xml` +* **Linux:** `~/.config/JetBrains/ /options/github-copilot.xml` For example, if you are using IntelliJ IDEA 2021.1 on macOS, the file is located at `~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xml`. diff --git a/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise.md b/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise.md index de1efb4661f8..883a9bda8b87 100644 --- a/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise.md +++ b/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise.md @@ -34,6 +34,6 @@ Enable {% data variables.product.prodname_copilot_short %} for some or all organ ## 5. Share onboarding material -* **Share onboarding material**: Share onboarding material with each organization that you granted {% data variables.product.prodname_copilot_short %} access to. See "[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization)." -* **Encourage adoption**: Encouragement from leadership can help drive adoption of {% data variables.product.prodname_copilot_short %} in your enterprise. Consider messaging your support of {% data variables.product.prodname_copilot_short %} and how it can help your enterprise. -* **Set up training sessions or workshops**: Training sessions or workshops can help members learn how to use {% data variables.product.prodname_copilot_short %} effectively. +* **Share onboarding material:** Share onboarding material with each organization that you granted {% data variables.product.prodname_copilot_short %} access to. See "[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization)." +* **Encourage adoption:** Encouragement from leadership can help drive adoption of {% data variables.product.prodname_copilot_short %} in your enterprise. Consider messaging your support of {% data variables.product.prodname_copilot_short %} and how it can help your enterprise. +* **Set up training sessions or workshops:** Training sessions or workshops can help members learn how to use {% data variables.product.prodname_copilot_short %} effectively. diff --git a/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization.md b/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization.md index 46aa9a042993..3524118f5034 100644 --- a/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization.md +++ b/content/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization.md @@ -41,9 +41,9 @@ Alternatively, you can set up a self-serve workflow using the API. See "[Add tea ## 5. Share onboarding material -* **Share onboarding material**: Share onboarding material with each member that you granted {% data variables.product.prodname_copilot_short %} access to. See "[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-yourself)" and "[AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot)." -* **Encourage adoption**: Encouragement from leadership can help drive adoption of {% data variables.product.prodname_copilot_short %} in your organization. Consider messaging your support of {% data variables.product.prodname_copilot_short %} and how it can help your organization. -* **Set up training sessions or workshops**: Training sessions or workshops can help members learn how to use {% data variables.product.prodname_copilot_short %} effectively. +* **Share onboarding material:** Share onboarding material with each member that you granted {% data variables.product.prodname_copilot_short %} access to. See "[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-yourself)" and "[AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot)." +* **Encourage adoption:** Encouragement from leadership can help drive adoption of {% data variables.product.prodname_copilot_short %} in your organization. Consider messaging your support of {% data variables.product.prodname_copilot_short %} and how it can help your organization. +* **Set up training sessions or workshops:** Training sessions or workshops can help members learn how to use {% data variables.product.prodname_copilot_short %} effectively. ## 6. Enhance the {% data variables.product.prodname_copilot_short %} experience diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github-mobile.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github-mobile.md index 8f1deaa75991..a6a368d6a472 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github-mobile.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github-mobile.md @@ -44,12 +44,12 @@ The following {% ifversion fpt %}limitation applies{% else %} limitations apply{ To use {% data variables.product.prodname_copilot_mobile_short %} you will need the following. -* **Subscription to {% data variables.product.prodname_copilot %}**: You must have an active {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." +* **Subscription to {% data variables.product.prodname_copilot %}:** You must have an active {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." If you do not have a {% data variables.product.prodname_copilot %} subscription, you can purchase a {% data variables.product.prodname_copilot_individuals_short %} subscription directly in the iOS version of {% data variables.product.prodname_mobile %}, or in the Google Play Store for the Android version of {% data variables.product.prodname_mobile %}. -* **Access to {% data variables.product.prodname_copilot_mobile_short %}**: If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to grant you access to {% data variables.product.prodname_copilot_mobile_short %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/enabling-github-copilot-chat-for-github-mobile)." -* **Enable {% data variables.product.prodname_copilot_short %} features for your device**: {% data variables.product.prodname_copilot_short %} needs to be enabled from within {% data variables.product.prodname_mobile %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot#enabling-or-disabling-copilot-in-github-mobile)." If you cannot see the {% data variables.product.prodname_copilot_short %} logo in the {% data variables.product.prodname_mobile %} home page, you may need to update your app version. +* **Access to {% data variables.product.prodname_copilot_mobile_short %}:** If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to grant you access to {% data variables.product.prodname_copilot_mobile_short %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/enabling-github-copilot-chat-for-github-mobile)." +* **Enable {% data variables.product.prodname_copilot_short %} features for your device:** {% data variables.product.prodname_copilot_short %} needs to be enabled from within {% data variables.product.prodname_mobile %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot#enabling-or-disabling-copilot-in-github-mobile)." If you cannot see the {% data variables.product.prodname_copilot_short %} logo in the {% data variables.product.prodname_mobile %} home page, you may need to update your app version. ## Asking a general question about software development diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md index 376127e7b934..3bfccf8d9669 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md @@ -167,9 +167,9 @@ You can tell {% data variables.product.prodname_copilot_short %} to answer a que In addition to submitting prompts through the chat view, you can submit prompts in other ways: -* **Inline**: To start an inline chat directly in the editor or integrated terminal, enter Command+i (Mac) / Ctrl+i (Windows/Linux). -* **Quick chat**: To open the quick chat dropdown, enter Shift+Command+i (Mac) / Shift+Ctrl+i (Windows/Linux) -* **Smart actions**: To submit prompts via the context menu, right click in your editor, select **Copilot** in the menu that appears, then select one of the actions. Smart actions can also be accessed via the sparkle icon that sometimes appears when you select a line of code. +* **Inline:** To start an inline chat directly in the editor or integrated terminal, enter Command+i (Mac) / Ctrl+i (Windows/Linux). +* **Quick chat:** To open the quick chat dropdown, enter Shift+Command+i (Mac) / Shift+Ctrl+i (Windows/Linux) +* **Smart actions:** To submit prompts via the context menu, right click in your editor, select **Copilot** in the menu that appears, then select one of the actions. Smart actions can also be accessed via the sparkle icon that sometimes appears when you select a line of code. See [inline chat](https://code.visualstudio.com/docs/copilot/copilot-chat#_inline-chat), [quick chat](https://code.visualstudio.com/docs/copilot/copilot-chat#_quick-chat), and [chat smart actions](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-smart-actions) in the {% data variables.product.prodname_vscode %} documentation for more details. diff --git a/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md b/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md index 40ea80fbcef6..7f50d22018c6 100644 --- a/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md +++ b/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md @@ -12,14 +12,14 @@ shortTitle: Best practices {% data variables.product.prodname_copilot %} is an AI coding assistant that helps you write code faster and with less effort, allowing you to focus more energy on problem solving and collaboration. Before you start working with {% data variables.product.prodname_copilot_short %}, it's important to understand when you should and shouldn't use it. -**Some of the things {% data variables.product.prodname_copilot_short %} does best include**: +**Some of the things {% data variables.product.prodname_copilot_short %} does best include:** * Writing tests and repetitive code * Debugging and correcting syntax * Explaining and commenting code * Generating regular expressions -**{% data variables.product.prodname_copilot_short %} is not designed to**: +**{% data variables.product.prodname_copilot_short %} is not designed to:** * Respond to prompts unrelated to coding and technology * Replace your expertise and skills. Remember that you are in charge, and {% data variables.product.prodname_copilot_short %} is a powerful tool at your service. @@ -28,14 +28,14 @@ shortTitle: Best practices While {% data variables.product.prodname_copilot_short %} code completions and {% data variables.product.prodname_copilot_chat_short %} share some functionality, the two tools are best used in different circumstances. -**Code completions work best for**: +**Code completions work best for:** * Completing code snippets, variable names, and functions as you write them * Generating repetitive code * Generating code from inline comments in natural language * Generating tests for test-driven development -**Alternatively, {% data variables.product.prodname_copilot_chat_short %} is best suited for**: +**Alternatively, {% data variables.product.prodname_copilot_chat_short %} is best suited for:** * Answering questions about code in natural language * Generating large sections of code, then iterating on that code to meet your needs @@ -67,7 +67,7 @@ While {% data variables.product.prodname_copilot_short %} is very powerful, it i There are several adjustments you can make to steer {% data variables.product.prodname_copilot_short %} towards more valuable responses: -* **Provide {% data variables.product.prodname_copilot_short %} with helpful context**: +* **Provide {% data variables.product.prodname_copilot_short %} with helpful context:** * If you are using {% data variables.product.prodname_copilot_short %} in your IDE, open relevant files and close irrelevant files. * In {% data variables.product.prodname_copilot_chat_short %}, if a particular request is no longer helpful context, delete that request from the conversation. Alternatively, if none of the context of a particular conversation is helpful, start a new conversation. * If you are using {% data variables.product.prodname_copilot_chat_dotcom_short %}, provide specific repositories, files, symbols, and more as context. See "[AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom)." diff --git a/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md b/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md index 2f5d2472fe0b..e65c796bdda6 100644 --- a/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md +++ b/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md @@ -24,8 +24,8 @@ redirect_from: {% data variables.copilot.copilot_code-review_short %} supports two types of review: -* **Review selection**: Highlight code and ask for an initial review _({% data variables.product.prodname_vscode %} only)_ -* **Review changes**: Request a deeper review of all your changes _({% data variables.product.github %} website and {% data variables.product.prodname_vscode %})_ +* **Review selection:** Highlight code and ask for an initial review _({% data variables.product.prodname_vscode %} only)_ +* **Review changes:** Request a deeper review of all your changes _({% data variables.product.github %} website and {% data variables.product.prodname_vscode %})_ The current functionality and availability of the two types of review is summarized in the following table: diff --git a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md b/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md index 8d00328da7de..2da03d0f17f9 100644 --- a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md +++ b/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md @@ -439,9 +439,9 @@ func CalculateDaysBetweenDates( If you encounter issues with code suggestions, such as conflicting or missing suggestions, you can try the following: -* **Disable Xcode's native predictive text completion**: To avoid receiving two sets of code suggestions, you can disable Xcode's native predictive text completion. You can find this setting in the Xcode settings in the "Editing" tab under "Text Editing". -* **Check for duplication detection in {% data variables.product.prodname_copilot_short %}**: 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)." -* **Check for updates and restart Xcode**: Ensure you have the latest version of {% data variables.product.prodname_copilot_short %} for Xcode in the extension application and restart Xcode. +* **Disable Xcode's native predictive text completion:** To avoid receiving two sets of code suggestions, you can disable Xcode's native predictive text completion. You can find this setting in the Xcode settings in the "Editing" tab under "Text Editing". +* **Check for duplication detection in {% data variables.product.prodname_copilot_short %}:** 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)." +* **Check for updates and restart Xcode:** Ensure you have the latest version of {% data variables.product.prodname_copilot_short %} for Xcode in the extension application and restart Xcode. You can also open an issue in the [{% data variables.product.prodname_copilot_short %} for Xcode repository](https://github.com/github/CopilotForXcode). diff --git a/content/copilot/using-github-copilot/guides-on-using-github-copilot/refactoring-code-with-github-copilot.md b/content/copilot/using-github-copilot/guides-on-using-github-copilot/refactoring-code-with-github-copilot.md index 04321af56fd3..d8613691f46d 100644 --- a/content/copilot/using-github-copilot/guides-on-using-github-copilot/refactoring-code-with-github-copilot.md +++ b/content/copilot/using-github-copilot/guides-on-using-github-copilot/refactoring-code-with-github-copilot.md @@ -53,7 +53,7 @@ done 1. Open {% data variables.product.prodname_copilot_chat_short %} by clicking the chat icon in the activity bar or by using the keyboard shortcut: * **{% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %}:** Control+Command+i (Mac) / Ctrl+Alt+i (Windows/Linux) - * **JetBrains**: Control+Shift+c + * **JetBrains:** Control+Shift+c 1. In the input box at the bottom of the chat panel, type: `Can this script be improved?` diff --git a/content/copilot/using-github-copilot/guides-on-using-github-copilot/writing-tests-with-github-copilot.md b/content/copilot/using-github-copilot/guides-on-using-github-copilot/writing-tests-with-github-copilot.md index 56937d493500..3dcf0fde4917 100644 --- a/content/copilot/using-github-copilot/guides-on-using-github-copilot/writing-tests-with-github-copilot.md +++ b/content/copilot/using-github-copilot/guides-on-using-github-copilot/writing-tests-with-github-copilot.md @@ -59,11 +59,11 @@ You can prompt Copilot with a request to write tests that cover a range of scena **Prompt:** _Develop a comprehensive suite of unit tests for the BankAccount() function in Python. Write multiple test methods that cover a wide range of scenarios, including edge cases, exception handling, and data validation._ This prompt does a few important things: -* **Scope**: It explicitly asks for a comprehensive suite of unit tests, so that {% data variables.product.prodname_copilot_short %} generates more than just basic tests, covering a variety of potential use cases. -* **Scenarios**: The prompt specifies that the tests should include: - * **Edge cases**: Tests for boundary conditions (e.g., negative values for deposits or withdrawals, withdrawing more than the available balance). - * **Exception handling**: Tests for errors that should be raised when certain invalid actions occur (e.g., withdrawing more than the available balance, depositing negative amounts). - * **Data validation**: Ensures that inputs are correctly validated and handled by the methods. +* **Scope:** It explicitly asks for a comprehensive suite of unit tests, so that {% data variables.product.prodname_copilot_short %} generates more than just basic tests, covering a variety of potential use cases. +* **Scenarios:** The prompt specifies that the tests should include: + * **Edge cases:** Tests for boundary conditions (e.g., negative values for deposits or withdrawals, withdrawing more than the available balance). + * **Exception handling:** Tests for errors that should be raised when certain invalid actions occur (e.g., withdrawing more than the available balance, depositing negative amounts). + * **Data validation:** Ensures that inputs are correctly validated and handled by the methods. {% data variables.product.prodname_copilot_short %} will give you a response like the following. @@ -188,10 +188,10 @@ Here we'll break down our request for {% data variables.product.prodname_copilot **Prompt:** _"Write integration tests for the `deposit` function in the `BankAccount` class. Use mocks to simulate the `NotificationSystem` and verify that it is called correctly after a deposit."_ This prompt does a few important things: -* **Scope**: It specifies integration tests, focusing on the interaction between the `deposit` function and the `NotificationSystem`, rather than just unit tests. -* **Mocks**: It explicitly asks for the use of mocks to simulate the `NotificationSystem`, ensuring that the interaction with external systems is tested without relying on their actual implementation. -* **Verification**: The prompt emphasizes verifying that the `NotificationSystem` is called correctly after a deposit, ensuring that the integration between the components works as expected. -* **Specificity**: The prompt clearly states the method (`deposit`) and the class (`BankAccount`) to be tested. +* **Scope:** It specifies integration tests, focusing on the interaction between the `deposit` function and the `NotificationSystem`, rather than just unit tests. +* **Mocks:** It explicitly asks for the use of mocks to simulate the `NotificationSystem`, ensuring that the interaction with external systems is tested without relying on their actual implementation. +* **Verification:** The prompt emphasizes verifying that the `NotificationSystem` is called correctly after a deposit, ensuring that the integration between the components works as expected. +* **Specificity:** The prompt clearly states the method (`deposit`) and the class (`BankAccount`) to be tested. > [!TIP] If {% data variables.product.prodname_copilot_short %} is producing invalid tests, provide examples of inputs and outputs for the function you want to test. This will help {% data variables.product.prodname_copilot_short %} evaluate the expected behavior of the function. diff --git a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md b/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md index 0996a94f47a1..b30c687ee732 100644 --- a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md +++ b/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md @@ -44,7 +44,7 @@ You can interact with your custom-built or installed extension in a {% data vari **If you have a {% data variables.product.prodname_copilot_individuals_short %} subscription**, you need to install a {% data variables.product.prodname_copilot_extension_short %} before you can use the extension in {% data variables.product.prodname_copilot_chat_short %}. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account)." -**If you have access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription**: +**If you have access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription:** 1. An organization owner or enterprise owner needs to enable the {% data variables.product.prodname_copilot_extensions_short %} policy for your organization or enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#setting-a-policy-for-github-copilot-extensions-in-your-organization)" and "[AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot)" in the {% data variables.product.prodname_ghe_cloud %} documentation. 1. An organization owner needs to install {% data variables.product.prodname_copilot_extensions_short %} for your organization. See "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization)." @@ -76,11 +76,11 @@ You can interact with your custom-built or installed extension in a {% data vari For questions and issues related to {% data variables.product.prodname_copilot_extensions %}, please use the following resources: -* **General issues for users and builders**: Visit the [{% data variables.product.github %} Support Portal](https://support.github.com/). -* **Requests or feedback for {% data variables.product.github %}**: Use the [{% data variables.product.github %} Community Discussion Thread](https://gh.io/community-feedback). -* **Requests or feedback for third-party extension publishers**: File an issue in the [User Feedback Repo](https://github.com/copilot-extensions/user-feedback) and add a label with the extension's slug name. -* **{% data variables.product.github %} Technology Partners**: Email the partnerships team directly for assistance. -* **{% data variables.product.prodname_copilot_extensions_vsc %}**: For more information on this type of {% data variables.product.prodname_copilot_extension_short %}, see [Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the {% data variables.product.prodname_vscode %} documentation. +* **General issues for users and builders:** Visit the [{% data variables.product.github %} Support Portal](https://support.github.com/). +* **Requests or feedback for {% data variables.product.github %}:** Use the [{% data variables.product.github %} Community Discussion Thread](https://gh.io/community-feedback). +* **Requests or feedback for third-party extension publishers:** File an issue in the [User Feedback Repo](https://github.com/copilot-extensions/user-feedback) and add a label with the extension's slug name. +* **{% data variables.product.github %} Technology Partners:** Email the partnerships team directly for assistance. +* **{% data variables.product.prodname_copilot_extensions_vsc %}:** For more information on this type of {% data variables.product.prodname_copilot_extension_short %}, see [Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the {% data variables.product.prodname_vscode %} documentation. > [!NOTE] {% data variables.product.github %} Support is not able to answer questions regarding {% data variables.product.prodname_copilot_extensions_vsc %}, as this implementation path is owned and maintained by the {% data variables.product.prodname_vscode_shortname %} team. diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md index 483593afd7c1..1e870c13c074 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md @@ -34,8 +34,8 @@ Once you are a verified {% data variables.product.prodname_global_campus %} stud * Discover student-created repositories from {% data variables.product.prodname_community_exchange %}. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)." {% data variables.product.prodname_global_campus %} students also receive the following {% data variables.product.prodname_dotcom %} benefits. -* **{% data variables.product.prodname_copilot %}**: Verified students receive a free subscription for {% data variables.product.prodname_copilot %}. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer)." -* **{% data variables.product.prodname_github_codespaces %}**: {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/overview)." +* **{% data variables.product.prodname_copilot %}:** Verified students receive a free subscription for {% data variables.product.prodname_copilot %}. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer)." +* **{% data variables.product.prodname_github_codespaces %}:** {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/overview)." > [!NOTE] > {% data reusables.education.note-on-student-codespaces-usage %} For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom)." diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md index c5e0f37bdad8..b466ae4c9ffd 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md @@ -15,20 +15,20 @@ Each assignment you create on {% data variables.product.prodname_classroom %} ha For individual assignments, you can view the following information at the top of the assignment overview page: -* **Rostered students**: The number of students on the classroom's roster. -* **Added students**: The number of {% data variables.product.prodname_dotcom %} accounts that have accepted the assignment and are not associated with a roster identifier. -* **Accepted students**: The number of accounts that have accepted this assignment. -* **Assignment submissions**: The number of students that have submitted the assignment. Submission is triggered at the assignment deadline. -* **Passing students**: The number of students currently passing the autograding tests for this assignment. +* **Rostered students:** The number of students on the classroom's roster. +* **Added students:** The number of {% data variables.product.prodname_dotcom %} accounts that have accepted the assignment and are not associated with a roster identifier. +* **Accepted students:** The number of accounts that have accepted this assignment. +* **Assignment submissions:** The number of students that have submitted the assignment. Submission is triggered at the assignment deadline. +* **Passing students:** The number of students currently passing the autograding tests for this assignment. For group assignments, you can view the following information at the top of the assignment overview page: -* **Total teams**: The number of teams that have been created. -* **Rostered students**: The number of students on the classroom's roster. -* **Students not on a team**: The number of students on the classroom roster who have not yet joined a team. -* **Accepted teams**: The number of teams who have accepted this assignment. -* **Assignment submissions**: The number of teams that have submitted the assignment. Submission is triggered at the assignment deadline. -* **Passing teams**: The number of teams that are currently passing the autograding tests for this assignment. +* **Total teams:** The number of teams that have been created. +* **Rostered students:** The number of students on the classroom's roster. +* **Students not on a team:** The number of students on the classroom roster who have not yet joined a team. +* **Accepted teams:** The number of teams who have accepted this assignment. +* **Assignment submissions:** The number of teams that have submitted the assignment. Submission is triggered at the assignment deadline. +* **Passing teams:** The number of teams that are currently passing the autograding tests for this assignment. ## Viewing the assignment overview page for an assignment diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md index 1177bdaf7c66..18e72baa867d 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md @@ -40,7 +40,7 @@ An input/output test optionally runs a setup command, then provides standard inp | **Run command** | The command to run the test and generate standard output for evaluation | | **Inputs** | Standard input for run command | | **Expected output** | The output that you want to see as standard output from the run command | -| **Comparison** | The type of comparison between the run command's output and the expected output | +| **Comparison** | The type of comparison between the run command's output and the expected output
- **Included**: Passes when the expected output appears
anywhere in the standard output from the run command- **Exact**: Passes when the expected output is completely identical
to the standard output from the run command- **Regex**: Passes if the regular expression in expected
output matches against the standard output from the run command| | **Timeout** | In minutes, how long a test should run before resulting in failure | | **Points** | _Optional_. The number of points the test is worth toward a total score | @@ -106,9 +106,9 @@ By default, autograding tests will automatically run whenever a student pushes t {% data reusables.classroom.assignments-click-pencil %} 1. In the left sidebar, click **Grading and feedback**. 1. Below your list of autograding tests, you can configure when autograding tests are run. - * **Every time a student submits an assignment**: This is the default behavior. - * **On a schedule**: You can set a time every day or every week for autograding tests to be run. - * **Manually**: Autograding test runs will be manually triggered by you from the assignment dashboard. + * **Every time a student submits an assignment:** This is the default behavior. + * **On a schedule:** You can set a time every day or every week for autograding tests to be run. + * **Manually:** Autograding test runs will be manually triggered by you from the assignment dashboard. ## Viewing and downloading results from autograding tests diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md index 2a9d3eb41cf0..2a8133adfdf9 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md @@ -45,10 +45,10 @@ The default base role is `write`, meaning that everyone in the organization can ![Screenshot showing the "Who has access" settings. The dropdown for setting the base role is highlighted with an orange outline.](/assets/images/help/projects-v2/base-role.png) - * **No access**: Only organization owners and users granted individual access can see the project. Organization owners are also admins for the project. - * **Read**: Everyone in the organization can see the project. Organization owners are also admins for the project. - * **Write**: Everyone in the organization can see and edit the project. Organization owners are also admins for the project. - * **Admin**: Everyone in the organization is an admin for the project. + * **No access:** Only organization owners and users granted individual access can see the project. Organization owners are also admins for the project. + * **Read:** Everyone in the organization can see the project. Organization owners are also admins for the project. + * **Write:** Everyone in the organization can see and edit the project. Organization owners are also admins for the project. + * **Admin:** Everyone in the organization is an admin for the project. ### Managing access for teams and individual members of your organization @@ -69,9 +69,9 @@ You can only invite an individual user to collaborate on your organization-level ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) 1. Select the role for the collaborator. - * **Read**: The team or individual can view the project. - * **Write**: The team or individual can view and edit the project. - * **Admin**: The team or individual can view, edit, and add new collaborators to the project. + * **Read:** The team or individual can view the project. + * **Write:** The team or individual can view and edit the project. + * **Admin:** The team or individual can view, edit, and add new collaborators to the project. 1. Click **Invite**. ### Managing access of an existing collaborator on your project @@ -104,9 +104,9 @@ This only affects collaborators for your project, not for repositories in your p ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) 1. Select the role for the collaborator. - * **Read**: The individual can view the project. - * **Write**: The individual can view and edit the project. - * **Admin**: The individual can view, edit, and add new collaborators to the project. + * **Read:** The individual can view the project. + * **Write:** The individual can view and edit the project. + * **Admin:** The individual can view, edit, and add new collaborators to the project. 1. Click **Invite**. ### Managing access of an existing collaborator on your project diff --git a/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md b/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md index 7b5c09338124..ddd604713790 100644 --- a/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md +++ b/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md @@ -24,10 +24,10 @@ When starting a new project, initiative, or feature, the first step is to create You can set up repositories for different purposes based on your needs. The following are some common use cases: -* **Product repositories**: Larger organizations that track their work and goals around specific products may have one or more repositories containing the code and other files. These repositories can also be used for documentation, reporting on product health or future plans for the product. -* **Project repositories**: You can create a repository for an individual project you are working on, or for a project you are collaborating on with others. For an organization that tracks work for short-lived initiatives or projects, such as a consulting firm, there is a need to report on the health of a project and move people between different projects based on skills and needs. Code for the project is often contained in a single repository. -* **Team repositories**: For an organization that groups people into teams, and brings projects to them, such as a dev tools team, code may be scattered across many repositories for the different work they need to track. In this case it may be helpful to have a team-specific repository as one place to track all the work the team is involved in. -* **Personal repositories**: You can create a personal repository to track all your work in one place, plan future tasks, or even add notes or information you want to save. You can also add collaborators if you want to share this information with others. +* **Product repositories:** Larger organizations that track their work and goals around specific products may have one or more repositories containing the code and other files. These repositories can also be used for documentation, reporting on product health or future plans for the product. +* **Project repositories:** You can create a repository for an individual project you are working on, or for a project you are collaborating on with others. For an organization that tracks work for short-lived initiatives or projects, such as a consulting firm, there is a need to report on the health of a project and move people between different projects based on skills and needs. Code for the project is often contained in a single repository. +* **Team repositories:** For an organization that groups people into teams, and brings projects to them, such as a dev tools team, code may be scattered across many repositories for the different work they need to track. In this case it may be helpful to have a team-specific repository as one place to track all the work the team is involved in. +* **Personal repositories:** You can create a personal repository to track all your work in one place, plan future tasks, or even add notes or information you want to save. You can also add collaborators if you want to share this information with others. You can create multiple, separate repositories if you want different access permissions for the source code and for tracking issues and discussions. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-an-issues-only-repository)." diff --git a/content/migrations/overview/migration-paths-to-github.md b/content/migrations/overview/migration-paths-to-github.md index 856a4a0ac52d..4fea074b00f7 100644 --- a/content/migrations/overview/migration-paths-to-github.md +++ b/content/migrations/overview/migration-paths-to-github.md @@ -40,23 +40,23 @@ You can review the scope and tooling for your migration to {% data variables.pro ### {% data variables.product.prodname_ghe_server %} 3.4.1 or newer to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * {% data reusables.migrations.large-repositories-require-expert-services %} * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-githubcom %} ### {% data variables.product.prodname_ghe_server %} 3.4.0 or older to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * {% data reusables.migrations.large-repositories-require-expert-services %} * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-githubcom %} @@ -64,97 +64,97 @@ You can review the scope and tooling for your migration to {% data variables.pro Migrations from {% data variables.product.prodname_dotcom_the_website %} include {% data variables.product.prodname_ghe_cloud %}. This path includes adoption of {% data variables.product.prodname_emus %} or a move between managed enterprises. -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} or {% data variables.product.prodname_expert_services %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} or {% data variables.product.prodname_expert_services %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * {% data reusables.migrations.large-repositories-require-expert-services %} * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-githubcom %} ### Azure DevOps Services (Azure DevOps Cloud) to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: "[AUTOTITLE](/migrations/using-github-enterprise-importer)" +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** "[AUTOTITLE](/migrations/using-github-enterprise-importer)" ### Azure DevOps Server to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source, history, and metadata -* **Tooling**: Migration to Azure DevOps Services, then {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** Migration to Azure DevOps Services, then {% data variables.product.prodname_importer_proper_name %} +* **More information:** * [Migrate data from Azure DevOps Server to Azure DevOps Services](https://learn.microsoft.com/en-us/azure/devops/migrate/migration-overview?view=azure-devops) in the Microsoft Docs * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" -* **Caveats**: If you can't migrate to Azure DevOps Services first, you must perform a "source and history" migration instead. For more information, "[Migrations from any Git repository to {% data variables.product.prodname_dotcom_the_website %}](#any-git-repository-to-githubcom)." +* **Caveats:** If you can't migrate to Azure DevOps Services first, you must perform a "source and history" migration instead. For more information, "[Migrations from any Git repository to {% data variables.product.prodname_dotcom_the_website %}](#any-git-repository-to-githubcom)." ### Bitbucket Cloud (Bitbucket.org) to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source and history -* **Tooling**: Git CLI or {% data variables.product.prodname_importer %} -* **More information**: +* **Scope:** Source and history +* **Tooling:** Git CLI or {% data variables.product.prodname_importer %} +* **More information:** * "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" * "[AUTOTITLE]({% ifversion ghes %}/free-pro-team@latest{% endif %}/migrations/importing-source-code/using-github-importer/about-github-importer)" ### Bitbucket Server or Bitbucket Data Center to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * For complex repositories larger than around 5 GB, you may need to use `bbs-exporter` and Enterprise Cloud Importer instead. Enterprise Cloud Importer is only available for expert-led migrations. * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-githubcom %} ### GitLab to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source, history, and metadata -* **Tooling**: `gl-exporter`, then Enterprise Cloud Importer (expert-led migrations only) -* **More information**: [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Scope:** Source, history, and metadata +* **Tooling:** `gl-exporter`, then Enterprise Cloud Importer (expert-led migrations only) +* **More information:** [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website +* **Caveats:** * Enterprise Cloud Importer is only available for expert-led migrations. * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-githubcom %} ### Any Git repository to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source and history -* **Tooling**: Git CLI or {% data variables.product.prodname_importer %} if the repository is accessible over the public internet -* **More information**: +* **Scope:** Source and history +* **Tooling:** Git CLI or {% data variables.product.prodname_importer %} if the repository is accessible over the public internet +* **More information:** * "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" * "[AUTOTITLE]({% ifversion ghes %}/free-pro-team@latest{% endif %}/migrations/importing-source-code/using-github-importer/about-github-importer)" ### Any Mercurial repository to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source and history -* **Tooling**: Mercurial, Git CLI, and Python -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository)" +* **Scope:** Source and history +* **Tooling:** Mercurial, Git CLI, and Python +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository)" ### Any Subversion (SVN) repository to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source and history -* **Tooling**: Subversion and Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository)" +* **Scope:** Source and history +* **Tooling:** Subversion and Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository)" ### Any Team Foundation Version Control (TFVC) repository to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source and history -* **Tooling**: Azure Repos, then Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository)" +* **Scope:** Source and history +* **Tooling:** Azure Repos, then Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository)" ### Any Perforce repository to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source and history -* **Tooling**: `git-p4`, then Git CLI -* **More information**: +* **Scope:** Source and history +* **Tooling:** `git-p4`, then Git CLI +* **More information:** * [git-p4](https://git-scm.com/docs/git-p4) in the Git documentation * "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#importing-a-git-repository-with-the-command-line)" ### Any other repository to {% data variables.product.prodname_dotcom_the_website %} -* **Scope**: Source snapshot -* **Tooling**: {% data variables.product.prodname_cli %} or Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" +* **Scope:** Source snapshot +* **Tooling:** {% data variables.product.prodname_cli %} or Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" ### {% data variables.enterprise.data_residency_site %} to {% data variables.product.prodname_dotcom_the_website %} @@ -185,116 +185,116 @@ Follow a link below to review the scope and tooling for your migration to {% dat ### {% data variables.product.prodname_ghe_server %} 3.4.1 or newer to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * {% data reusables.migrations.large-repositories-require-expert-services-ghecom %} * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghecom %} ### {% data variables.product.prodname_ghe_server %} 3.4.0 or older to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * {% data reusables.migrations.large-repositories-require-expert-services-ghecom %} * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghecom %} ### {% data variables.product.prodname_dotcom_the_website %} to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} or {% data variables.product.prodname_expert_services %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} or {% data variables.product.prodname_expert_services %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * {% data reusables.migrations.large-repositories-require-expert-services-ghecom %} * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghecom %} ### Azure DevOps Services (Azure DevOps Cloud) to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: "[AUTOTITLE](/migrations/using-github-enterprise-importer)" +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** "[AUTOTITLE](/migrations/using-github-enterprise-importer)" ### Azure DevOps Server to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source, history, and metadata -* **Tooling**: Migration to Azure DevOps Services, then {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** Migration to Azure DevOps Services, then {% data variables.product.prodname_importer_proper_name %} +* **More information:** * [Migrate data from Azure DevOps Server to Azure DevOps Services](https://learn.microsoft.com/en-us/azure/devops/migrate/migration-overview?view=azure-devops) in the Microsoft Docs * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" -* **Caveats**: If you can't migrate to Azure DevOps Services first, you must perform a "source and history" migration instead. For more information, see "[Migrations from any Git repository to {% data variables.enterprise.data_residency_site %}](#any-git-repository-to-githubcom)." +* **Caveats:** If you can't migrate to Azure DevOps Services first, you must perform a "source and history" migration instead. For more information, see "[Migrations from any Git repository to {% data variables.enterprise.data_residency_site %}](#any-git-repository-to-githubcom)." ### Bitbucket Cloud (Bitbucket.org) to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source and history -* **Tooling**: Git CLI -* **More information**: +* **Scope:** Source and history +* **Tooling:** Git CLI +* **More information:** * "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" ### Bitbucket Server or Bitbucket Data Center to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source, history, and metadata -* **Tooling**: {% data variables.product.prodname_importer_proper_name %} -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** {% data variables.product.prodname_importer_proper_name %} +* **More information:** * "[AUTOTITLE](/migrations/using-github-enterprise-importer)" * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Caveats:** * {% data reusables.migrations.large-repositories-require-expert-services-ghecom %} * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghecom %} ### GitLab to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source, history, and metadata -* **Tooling**: Contact {% data variables.product.prodname_expert_services %} -* **More information**: [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website -* **Caveats**: +* **Scope:** Source, history, and metadata +* **Tooling:** Contact {% data variables.product.prodname_expert_services %} +* **More information:** [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website +* **Caveats:** * {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghecom %} ### Any Git repository to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source and history -* **Tooling**: Git CLI -* **More information**: +* **Scope:** Source and history +* **Tooling:** Git CLI +* **More information:** * "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" ### Any Mercurial repository to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source and history -* **Tooling**: Mercurial, Git CLI, and Python -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository)" +* **Scope:** Source and history +* **Tooling:** Mercurial, Git CLI, and Python +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository)" ### Any Subversion (SVN) repository to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source and history -* **Tooling**: Subversion and Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository)" +* **Scope:** Source and history +* **Tooling:** Subversion and Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository)" ### Any Team Foundation Version Control (TFVC) repository to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source and history -* **Tooling**: Azure Repos, then Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository)" +* **Scope:** Source and history +* **Tooling:** Azure Repos, then Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository)" ### Any Perforce repository to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source and history -* **Tooling**: `git-p4`, then Git CLI -* **More information**: +* **Scope:** Source and history +* **Tooling:** `git-p4`, then Git CLI +* **More information:** * [git-p4](https://git-scm.com/docs/git-p4) in the Git documentation * "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#importing-a-git-repository-with-the-command-line)" ### Any other repository to {% data variables.enterprise.data_residency_site %} -* **Scope**: Source snapshot -* **Tooling**: {% data variables.product.prodname_cli %} or Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" +* **Scope:** Source snapshot +* **Tooling:** {% data variables.product.prodname_cli %} or Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" ## Migrations to {% data variables.product.prodname_ghe_server %} @@ -318,87 +318,87 @@ You can review the scope and tooling for your migration to {% data variables.pro Migrations from {% data variables.product.prodname_dotcom_the_website %} include {% data variables.product.prodname_ghe_cloud %}. -* **Scope**: Source, history, and metadata -* **Tooling**: Organization migrations API, then `ghe-migrator` -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** Organization migrations API, then `ghe-migrator` +* **More information:** * "[AUTOTITLE](/enterprise-server/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom)" * "[AUTOTITLE](/enterprise-server/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)" ### {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source, history, and metadata -* **Tooling**: Organization migrations API, then `ghe-migrator` -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** Organization migrations API, then `ghe-migrator` +* **More information:** * "[AUTOTITLE](/enterprise-server/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server)" * "[AUTOTITLE](/enterprise-server/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)" ### Azure DevOps to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source and history -* **Tooling**: Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" +* **Scope:** Source and history +* **Tooling:** Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" ### Bitbucket Cloud (Bitbucket.org) to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source and history -* **Tooling**: Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" +* **Scope:** Source and history +* **Tooling:** Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" ### Bitbucket Server or Bitbucket Data Center to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source, history, and metadata -* **Tooling**: `bbs-exporter` (expert-led migrations only), then `ghe-migrator` -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** `bbs-exporter` (expert-led migrations only), then `ghe-migrator` +* **More information:** * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website * "[AUTOTITLE](/enterprise-server/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)" -* **Caveats**: {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghes %} +* **Caveats:** {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghes %} ### GitLab to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source, history, and metadata -* **Tooling**: `gl-exporter` (expert-led migrations only), then `ghe-migrator` -* **More information**: +* **Scope:** Source, history, and metadata +* **Tooling:** `gl-exporter` (expert-led migrations only), then `ghe-migrator` +* **More information:** * [{% data variables.product.prodname_expert_services %}](https://github.com/services/) website * "[AUTOTITLE](/enterprise-server/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)" -* **Caveats**: {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghes %} +* **Caveats:** {% data reusables.migrations.migration-instructions-for-any-git-repository-to-ghes %} ### Any Git repository to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source and history -* **Tooling**: Git CLI -* **More information**: "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" +* **Scope:** Source and history +* **Tooling:** Git CLI +* **More information:** "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" ### Any Mercurial repository to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source and history -* **Tooling**: Mercurial, Git CLI, and Python -* **More information**: "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository)" +* **Scope:** Source and history +* **Tooling:** Mercurial, Git CLI, and Python +* **More information:** "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository)" ### Any Subversion (SVN) repository to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source and history -* **Tooling**: Subversion and Git CLI -* **More information**: "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository)" +* **Scope:** Source and history +* **Tooling:** Subversion and Git CLI +* **More information:** "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository)" ### Any Team Foundation Version Control (TFVC) repository to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source and history -* **Tooling**: Azure Repos, then Git CLI -* **More information**: "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository)" +* **Scope:** Source and history +* **Tooling:** Azure Repos, then Git CLI +* **More information:** "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository)" ### Any Perforce repository to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source and history -* **Tooling**: `git-p4`, then Git CLI -* **More information**: +* **Scope:** Source and history +* **Tooling:** `git-p4`, then Git CLI +* **More information:** * [git-p4](https://git-scm.com/docs/git-p4) in the Git documentation * "[AUTOTITLE](/enterprise-server/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#importing-a-git-repository-with-the-command-line)" ### Any other repository to {% data variables.product.prodname_ghe_server %} -* **Scope**: Source snapshot -* **Tooling**: {% data variables.product.prodname_cli %} or Git CLI -* **More information**: "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" +* **Scope:** Source snapshot +* **Tooling:** {% data variables.product.prodname_cli %} or Git CLI +* **More information:** "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github)" ### {% data variables.enterprise.data_residency_site %} to {% data variables.product.prodname_ghe_server %} diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.md index 2e644b046b46..2938f0df4133 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.md @@ -78,11 +78,11 @@ The base repository role determines the initial set of permissions included in t The base repository roles are: -* **Read**: Grants read access to all repositories in the organization. -* **Write**: Grants write access to all repositories in the organization. -* **Triage**: Grants triage access to all repositories in the organization. -* **Maintain**: Grants maintenance access to all repositories in the organization. -* **Admin**: Grants admin access to all repositories in the organization. +* **Read:** Grants read access to all repositories in the organization. +* **Write:** Grants write access to all repositories in the organization. +* **Triage:** Grants triage access to all repositories in the organization. +* **Maintain:** Grants maintenance access to all repositories in the organization. +* **Admin:** Grants admin access to all repositories in the organization. ## Additional permissions for repository access diff --git a/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md index c790b3c3fc3e..b8786271ed4c 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md @@ -13,8 +13,8 @@ shortTitle: Set a token policy ## Restricting access by {% data variables.product.pat_generic_plural %} Organization owners can prevent {% data variables.product.pat_generic_plural %} from accessing resources owned by the organization with the following options: -* **Restrict access via {% data variables.product.pat_generic_plural %}**: {% data variables.product.pat_v1_caps_plural %} or {% data variables.product.pat_v2_plural %} cannot access resources owned by the organization. SSH keys created by {% data variables.product.pat_generic_plural %} will continue to work. -* **Allow access via {% data variables.product.pat_generic_plural %}**: {% data variables.product.pat_v1_caps_plural %} or {% data variables.product.pat_v2_plural %} can access resources owned by the organization. +* **Restrict access via {% data variables.product.pat_generic_plural %}:** {% data variables.product.pat_v1_caps_plural %} or {% data variables.product.pat_v2_plural %} cannot access resources owned by the organization. SSH keys created by {% data variables.product.pat_generic_plural %} will continue to work. +* **Allow access via {% data variables.product.pat_generic_plural %}:** {% data variables.product.pat_v1_caps_plural %} or {% data variables.product.pat_v2_plural %} can access resources owned by the organization. Regardless of the chosen policy, {% data variables.product.pat_generic_caps_plural %} will have access to public resources within the organization. @@ -48,8 +48,8 @@ When you set a policy, tokens with non-compliant lifetimes will be blocked from ## Enforcing an approval policy for {% data variables.product.pat_v2_plural %} Organization owners can manage approval requirements for each {% data variables.product.pat_v2 %} that can access the organization with the following options: - * **Require administrator approval**: An organization owner must approve each {% data variables.product.pat_v2 %} that can access the organization. {% data variables.product.pat_v2_caps_plural %} created by organization owners will not need approval. - * **Do not require administrator approval**: {% data variables.product.pat_v2_caps %}s created by organization members can access resources in the organization without prior approval. + * **Require administrator approval:** An organization owner must approve each {% data variables.product.pat_v2 %} that can access the organization. {% data variables.product.pat_v2_caps_plural %} created by organization owners will not need approval. + * **Do not require administrator approval:** {% data variables.product.pat_v2_caps %}s created by organization members can access resources in the organization without prior approval. {% data variables.product.pat_v2_caps %}s will still be able to read public resources within the organization without approval. diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md index 3458024bb8ad..ead662e282b8 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md @@ -23,11 +23,11 @@ shortTitle: Repository roles You can give organization members, outside collaborators, and teams of people different levels of access to repositories owned by an organization by assigning them to roles. Choose the role that best fits each person or team's function in your project without giving people more access to the project than they need. From least access to most access, the roles for an organization repository are: -* **Read**: Recommended for non-code contributors who want to view or discuss your project -* **Triage**: Recommended for contributors who need to proactively manage issues{% ifversion discussions-moderators-control-who-can-report %}, discussions,{% endif %} and pull requests without write access -* **Write**: Recommended for contributors who actively push to your project -* **Maintain**: Recommended for project managers who need to manage the repository without access to sensitive or destructive actions -* **Admin**: Recommended for people who need full access to the project, including sensitive and destructive actions like managing security or deleting a repository +* **Read:** Recommended for non-code contributors who want to view or discuss your project +* **Triage:** Recommended for contributors who need to proactively manage issues{% ifversion discussions-moderators-control-who-can-report %}, discussions,{% endif %} and pull requests without write access +* **Write:** Recommended for contributors who actively push to your project +* **Maintain:** Recommended for project managers who need to manage the repository without access to sensitive or destructive actions +* **Admin:** Recommended for people who need full access to the project, including sensitive and destructive actions like managing security or deleting a repository {% ifversion fpt %} If your organization uses {% data variables.product.prodname_ghe_cloud %}, you can create custom repository roles. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization)" in the {% data variables.product.prodname_ghe_cloud %} documentation. diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md index f83439462e30..e1c2a5cb5ba9 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md @@ -29,9 +29,9 @@ For an introduction to requesting and providing pull request reviews, see the [R {% ifversion fpt or ghec %}You can schedule reminders for pull requests that need to be reviewed. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team)."{% endif %} A review has three possible statuses: -* **Comment**: Submit general feedback without explicitly approving the changes or requesting additional changes. -* **Approve**: Submit feedback and approve merging the changes proposed in the pull request. -* **Request changes**: Submit feedback that must be addressed before the pull request can be merged. +* **Comment:** Submit general feedback without explicitly approving the changes or requesting additional changes. +* **Approve:** Submit feedback and approve merging the changes proposed in the pull request. +* **Request changes:** Submit feedback that must be addressed before the pull request can be merged. {% data reusables.repositories.request-changes-tips %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index 37e4043844be..70c457442a13 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -53,19 +53,19 @@ Repository administrators can require a merge queue by enabling the branch prote Once you have enabled the "Require merge queue" setting, you can also access the following settings: -* **Merge method**: Select which method to use when merging queued pull requests: merge, rebase, or squash. +* **Merge method:** Select which method to use when merging queued pull requests: merge, rebase, or squash. -* **Build concurrency**: The maximum number of `merge_group` webhooks to dispatch (between `1` and `100`), throttling the total amount of concurrent CI builds. This affects the velocity of merges that a merge queue can complete. -* **Only merge non-failing pull requests**: This setting determines how a merge queue forms groups of pull requests to be merged. +* **Build concurrency:** The maximum number of `merge_group` webhooks to dispatch (between `1` and `100`), throttling the total amount of concurrent CI builds. This affects the velocity of merges that a merge queue can complete. +* **Only merge non-failing pull requests:** This setting determines how a merge queue forms groups of pull requests to be merged. | Enabled? | Description | | -------- | ----------- | | Yes | All pull requests must satisfy required checks to be merged. | | No | Pull requests that have failed required checks can be added to a group as long as the last pull request in the group has passed required checks. If the last pull request in the group has passed required checks, this means that the checks have passed for the combined set of changes in the merge group. Leaving this checkbox unselected can be useful if you have intermittent test failures, but don't want false negatives to hold up the queue. | -* **Status check timeout**: Choose how long the queue should wait for a response from CI before assuming that checks have failed. +* **Status check timeout:** Choose how long the queue should wait for a response from CI before assuming that checks have failed. -* **Merge limits**: Select the minimum and maximum number of pull requests to merge into the base branch at the same time (between `1` and `100`), and a timeout after which the queue should stop waiting for more entries and merge with fewer than the minimum number. +* **Merge limits:** Select the minimum and maximum number of pull requests to merge into the base branch at the same time (between `1` and `100`), and a timeout after which the queue should stop waiting for more entries and merge with fewer than the minimum number. > [!NOTE] > Merge limits do not combine `merge_group` **builds**. Merge limits only affect merges to the base branch once one or more `merge_group` has satisfied build checks. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md index 5a71c6e1efbf..e73b0341e380 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md @@ -16,10 +16,10 @@ shortTitle: View branches {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %} 1. Use the navigation at the top of the page to view specific lists of branches: - * **Your branches**: In repositories that you have push access to, the **Yours** view shows all branches that you’ve pushed to, excluding the default branch, with the most recent branches first. - * **Active branches**: The **Active** view shows all branches (excluding the default branch) that anyone has committed to within the last three months, ordered by the branches with the most recent commits first. - * **Stale branches**: The **Stale** view shows all branches that no one has committed to in the last three months, ordered by the branches with the oldest commits first. Use this list to determine [which branches to delete](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository). - * **All branches**: The **All** view shows the default branch, followed by all other branches ordered by the branches with the most recent commits first. + * **Your branches:** In repositories that you have push access to, the **Yours** view shows all branches that you’ve pushed to, excluding the default branch, with the most recent branches first. + * **Active branches:** The **Active** view shows all branches (excluding the default branch) that anyone has committed to within the last three months, ordered by the branches with the most recent commits first. + * **Stale branches:** The **Stale** view shows all branches that no one has committed to in the last three months, ordered by the branches with the oldest commits first. Use this list to determine [which branches to delete](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository). + * **All branches:** The **All** view shows the default branch, followed by all other branches ordered by the branches with the most recent commits first. 1. Optionally, use the search field on the top right. It provides a simple, case-insensitive, sub-string search on the branch name. It does not support any additional query syntax. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md index bd923f48de8e..9c45b9936f02 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md @@ -53,16 +53,16 @@ You can require that merges must be performed with a merge queue at the reposito You can configure various settings for your merge queue rule. -* **Merge method**: Method to use when merging changes from pull requests. -* **Build concurrency**: Limit the number of queued pull requests requesting checks and workflow runs at the same time. +* **Merge method:** Method to use when merging changes from pull requests. +* **Build concurrency:** Limit the number of queued pull requests requesting checks and workflow runs at the same time. * This setting controls when merge queue dispatches the `merge_group.checks_requested` webhook event, which triggers {% data variables.product.prodname_actions %} workflows that are configured to run on `merge_group`. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#merge_group)." * For example, if there are 5 pull requests added to the queue and the build concurrency setting is 3, merge queue will dispatch the `checks_requested` event for the first 3 pull requests. When it receives a result for one of those pull requests, merge queue will dispatch the event for the 4th pull request, and so on. -* **Minimum/maximum group size**: The number of pull requests that will be merged together in a group. -* **Wait time to meet minimum group size (minutes)**: The time the merge queue will wait after the first pull request is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. -* **Require all queue entries to pass required checks**: +* **Minimum/maximum group size:** The number of pull requests that will be merged together in a group. +* **Wait time to meet minimum group size (minutes):** The time the merge queue will wait after the first pull request is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. +* **Require all queue entries to pass required checks:** * When this setting is enabled, each item in the merge group must pass all required checks. * When this setting is disabled, only the commit at the head of the merge group, i.e. the commit containing changes from all of the pull requests in the group, must pass its required checks to merge. -* **Status check timeout (minutes)**: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed +* **Status check timeout (minutes):** Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed {% endif %} diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index 700b960cefa0..3850b5ed9e39 100644 --- a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -234,19 +234,19 @@ Use the {% data variables.product.prodname_cli %} `api` subcommand to make your In your request, specify the following options and values: {%- ifversion not fpt %} -* **--hostname**: If you are authenticated to multiple accounts across {% data variables.product.github %} platforms, specify where you are making the request. For example: `--hostname {% data variables.enterprise.data_residency_example_domain %}`. +* **--hostname:** If you are authenticated to multiple accounts across {% data variables.product.github %} platforms, specify where you are making the request. For example: `--hostname {% data variables.enterprise.data_residency_example_domain %}`. {%- endif %} * **--method** followed by the HTTP method and the path of the endpoint. For more information, see "[HTTP method](#http-method)" and "[Path](#path)." -* **--header**: - * **`Accept`**: Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." - * **`X-GitHub-Api-Version`**: Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." +* **--header:** + * **`Accept`:** Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." + * **`X-GitHub-Api-Version`:** Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." * **`-f`** or **`-F`** followed by any body parameters or query parameters in `key=value` format. Use the `-F` option to pass a parameter that is a number, Boolean, or null. Use the `-f` option to pass string parameters. Some endpoints use query parameters that are arrays. To send an array in the query string, use the query parameter once per array item, and append `[]` after the query parameter name. For example, to provide an array of two repository IDs, use `-f repository_ids[]=REPOSITORY_A_ID -f repository_ids[]=REPOSITORY_B_ID`. If you do not need to specify any body parameters or query parameters in your request, omit this option. For more information, see "[Body parameters](#body-parameters)" and "[Query parameters](#query-parameters)." For examples, see "[Example request using body parameters](#example-request-using-body-parameters)" and "[Example request using query parameters](#example-request-using-query-parameters)." {%- ifversion not fpt %} -* **--hostname**: If you are authenticated to multiple accounts across {% data variables.product.github %} platforms, specify where you are making the request. For example: `--hostname {% data variables.enterprise.data_residency_example_domain %}`. +* **--hostname:** If you are authenticated to multiple accounts across {% data variables.product.github %} platforms, specify where you are making the request. For example: `--hostname {% data variables.enterprise.data_residency_example_domain %}`. {%- endif %} #### Example request @@ -318,10 +318,10 @@ Specify the following options and values in your request: * **`--url`** followed by the full path as the value. The full path is a URL that includes the base URL for the GitHub REST API (`{% data variables.product.rest_url %}`{% ifversion ghec %} or `https://{% data variables.enterprise.data_residency_api %}`, depending on where you access {% data variables.product.github %}{% endif %}) and the path of the endpoint, like this: `{% data variables.product.rest_url %}/PATH`.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `PATH` with the path of the endpoint. For more information, see "[Path](#path)." To use query parameters, add a `?` to the end of the path, then append your query parameter name and value in the form `parameter_name=value`. Separate multiple query parameters with `&`. If you need to send an array in the query string, use the query parameter once per array item, and append `[]` after the query parameter name. For example, to provide an array of two repository IDs, use `?repository_ids[]=REPOSITORY_A_ID&repository_ids[]=REPOSITORY_B_ID`. For more information, see "[Query parameters](#query-parameters)." For an example, see "[Example request using query parameters](#example-request-using-query-parameters-1)." -* **`--header` or `-H`**: - * **`Accept`**: Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma, for example: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." - * **`X-GitHub-Api-Version`**: Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." - * **`Authorization`**: Pass your authentication token in an `Authorization` header. Note that in most cases you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. For more information, see "[Authentication](#authentication)." For an example of a request that uses an `Authorization` header, see "[Example request using body parameters](#example-request-using-body-parameters-1)." +* **`--header` or `-H`:** + * **`Accept`:** Pass the media type in an `Accept` header. To pass multiple media types in an `Accept` header, separate the media types with a comma, for example: `Accept: application/vnd.github+json,application/vnd.github.diff`. For more information, see "[`Accept`](#accept)" and "[Media types](#media-types)." + * **`X-GitHub-Api-Version`:** Pass the API version in a `X-GitHub-Api-Version` header. For more information, see "[`X-GitHub-Api-Version`](#x-github-api-version)." + * **`Authorization`:** Pass your authentication token in an `Authorization` header. Note that in most cases you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. For more information, see "[Authentication](#authentication)." For an example of a request that uses an `Authorization` header, see "[Example request using body parameters](#example-request-using-body-parameters-1)." * **`--data` or `-d`** followed by any body parameters within a JSON object. If you do not need to specify any body parameters in your request, omit this option. For more information, see "[Body parameters](#body-parameters)." For an example, see "[Example request using body parameters](#example-request-using-body-parameters-1)." #### Example request diff --git a/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md b/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md index 0e2431922cb8..d848582bf6e4 100644 --- a/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md +++ b/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md @@ -56,19 +56,19 @@ GitHub has a non-retaliation policy for reporting workplace-related concerns. Co GitHub's labor practices are -**fair**: +**fair:** * GitHub pays its employees and contractors a fair wage, in accordance with applicable legal wages * GitHub maintains humane working conditions * GitHub does not require workers to exceed the maximum hours of daily labor set by local and national laws or regulations * GitHub pays its employees and contractors in a timely manner, with documentation (such as a pay stub) stating the basis on which they are paid, and keeps employee records in accordance with local and national laws -**humane and ethical**: +**humane and ethical:** * GitHub uses only voluntary labor * GitHub prohibits child labor * GitHub does not engage in physical discipline or abuse * GitHub does not tolerate harassment or unlawful discrimination in the workforce or workplace -**respectful**: +**respectful:** * GitHub protects its employees' rights to freedom of association and collective bargaining in accordance with legal requirements, including to post legal notices of employees' rights under the National Labor Relations Act * GitHub provides benefits to employees at or in excess of levels expected in the industry * GitHub encourages employees to report any workplace complaint and does not tolerate retaliation for reporting diff --git a/content/site-policy/github-terms/github-copilot-extension-developer-policy.md b/content/site-policy/github-terms/github-copilot-extension-developer-policy.md index f86f82fb99d0..d9a30aa99f5d 100644 --- a/content/site-policy/github-terms/github-copilot-extension-developer-policy.md +++ b/content/site-policy/github-terms/github-copilot-extension-developer-policy.md @@ -27,9 +27,9 @@ Violations of this Agreement may result in removing the Extension from the Platf While we want You to develop useful, fun, and interesting Extensions with GitHub Copilot, we want to make sure that our Users receive a safe, secure, productive, and enjoyable experience. When creating Extensions, you must understand the use cases and limitations of GitHub Copilot, and not rely on it for tasks where its use could lead to significant harm. With that in mind, You are required to comply with this Policy and other obligations. -**Terms of Service**: Your Extension must comply with the GitHub Terms of Service (ToS) including the Acceptable Use Policy. +**Terms of Service:** Your Extension must comply with the GitHub Terms of Service (ToS) including the Acceptable Use Policy. -**Security**: We take the security of Personal Data seriously and you must as well. As you develop your Extension, You must properly configure your systems to protect Personal Data and ensure that any stored Personal Data is encrypted. Furthermore, Extensions and developers must not: +**Security:** We take the security of Personal Data seriously and you must as well. As you develop your Extension, You must properly configure your systems to protect Personal Data and ensure that any stored Personal Data is encrypted. Furthermore, Extensions and developers must not: * Degrade or compromise security * Bypass or circumvent protocols and access controls @@ -38,7 +38,7 @@ While we want You to develop useful, fun, and interesting Extensions with GitHub * Transmit any viruses or other code that may damage, detrimentally interfere with, surreptitiously intercept or expropriate any system or Personal Data * Attempt to reverse engineer or otherwise derive source code, trade secrets, or know-how of the Platform or any portion thereof -**Use of Personal Data**: Protecting User privacy is paramount at GitHub, and must be for you. You are responsible for good Personal Data practices. You do not have independent rights to any Personal Data. In accordance with this, Extensions and developers are prohibited from: +**Use of Personal Data:** Protecting User privacy is paramount at GitHub, and must be for you. You are responsible for good Personal Data practices. You do not have independent rights to any Personal Data. In accordance with this, Extensions and developers are prohibited from: * Collecting, storing, and using Personal Data without obtaining proper User consent * Utilizing Personal Data to contact Users. You must gain permission through a clear and separate permissions process to contact Users outside of GitHub. Contacting Users is limited to emergencies in which the User’s safety and security is at risk and in compliance with the law @@ -52,7 +52,7 @@ While we want You to develop useful, fun, and interesting Extensions with GitHub * Accessing Data for surveillance purposes. You may not allow or assist any entity to conduct surveillance or obtain Personal Data using your access to the Platform * Otherwise exploiting Personal Data in a way not approved by GitHub and not disclosed to and permitted by Users. You may, however, use Data that is both aggregated and anonymized for purposes of analytics and development related to the Extension -**Law and Safety**: Extensions should not create unsafe environments or hardships for Users. Each Extension must comply with all applicable laws and legal requirements in all locations where it is made available to Users. In addition, Extensions and developers are prohibited from: +**Law and Safety:** Extensions should not create unsafe environments or hardships for Users. Each Extension must comply with all applicable laws and legal requirements in all locations where it is made available to Users. In addition, Extensions and developers are prohibited from: * Inferring people’s emotional states from their physical, physiological, or behavioral characteristics * Inferring people’s sensitive attributes such as gender, race, nationality, religion, or specific age (not including age range, position of mouth (e.g., smile or frown), and hair color) @@ -62,7 +62,7 @@ While we want You to develop useful, fun, and interesting Extensions with GitHub * For any real-time facial recognition technology on mobile cameras used by any law enforcement globally to attempt to identify individuals in uncontrolled, "in the wild" environments, which includes (without limitation) police officers on patrol using body-worn or dash-mounted cameras using facial recognition technology to attempt to identify individuals present in a database of suspects or prior inmates * Without the individual’s valid consent, for ongoing surveillance or real-time or near real-time identification or persistent tracking of the individual using any of their personal information, including biometric data -**Transparency**: GitHub Copilot is a generative artificial intelligence (AI) tool intended to increase developer productivity. You must inform Users of Your Extensions intended use cases, best practices, and limitations as well as when they are interacting with generative AI content. Furthermore, Extensions and developers must: +**Transparency:** GitHub Copilot is a generative artificial intelligence (AI) tool intended to increase developer productivity. You must inform Users of Your Extensions intended use cases, best practices, and limitations as well as when they are interacting with generative AI content. Furthermore, Extensions and developers must: * Test the Extension to ensure outputs do not violate this Agreement * Provide a mechanism for Users to report feedback to You and GitHub related to errors, bugs, improper, or undesired outputs diff --git a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md index 26c59ed430dd..2513d3071a73 100644 --- a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md +++ b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md @@ -75,7 +75,7 @@ Gists can either be public or secret (accessible only through a known URL). Publ Here is a non-exhaustive list of the kinds of data we maintain about users and projects on GitHub. * -**Public account data**: +**Public account data:** There is a variety of information publicly available on GitHub about users and their repositories. User profiles can be found at a URL such as `https://github.com/username`. User profiles display information about when the user created their account as well their public activity on GitHub.com and social interactions. @@ -96,7 +96,7 @@ All user public profiles display: * Organizations to which the user is a member (_depending on either the organizations' or the users' preferences_) * -**Private account data**: +**Private account data:** GitHub also collects and maintains certain private information about users as outlined in our [Privacy Policy](/site-policy/privacy-policies/github-privacy-statement). This may include: * Private email addresses @@ -107,7 +107,7 @@ This may include: To get a sense of the type of private account information that GitHub collects, you can visit your {% data reusables.user-settings.personal_dashboard %} and browse through the sections in the left-hand menubar. * -**Organization account data**: +**Organization account data:** Information about organizations, their administrative users and repositories is publicly available on GitHub. Organization profiles can be found at a URL such as `https://github.com/organization`. Public organization profiles can also include additional information that the owners have chosen to share publicly. @@ -124,7 +124,7 @@ All organization public profiles display: * Collaborators * -**Public repository data**: +**Public repository data:** GitHub is home to millions of public, open-source software projects. You can browse almost any public repository (for example, the [GitHub Docs](https://github.com/github/docs)) to get a sense for the information that GitHub collects and maintains about repositories. This can include: @@ -139,11 +139,11 @@ This can include: * Statistics and graphs showing contributions to the project and the network of contributors * -**Private repository data**: +**Private repository data:** GitHub collects and maintains the same type of data for private repositories that can be seen for public repositories, except only specifically invited users may access private repository data. * -**Other data**: +**Other data:** Additionally, GitHub collects analytics data such as page visits and information occasionally volunteered by our users (such as communications with our support team, survey information and/or site registrations). ## We will notify any affected account owners @@ -158,11 +158,11 @@ Where GitHub agrees to produce non-public information in response to a lawful re Here are the kinds of information we will agree to produce, depending on the kind of legal process we are served with: * -**With user consent**: +**With user consent:** GitHub will provide private account information, if requested, directly to the user (or an owner, in the case of an organization account), or to a designated third party with the user's written consent once GitHub is satisfied that the user has verified his or her identity. * -**With a subpoena**: +**With a subpoena:** If served with a valid subpoena, civil investigative demand, or similar legal process issued in connection with an official criminal or civil investigation, we can provide certain non-public account information, which may include: * Name(s) associated with the account @@ -177,7 +177,7 @@ In the case of organization accounts, we can provide the name(s) and email addre Please note that the information available will vary from case to case. Some of the information is optional for users to provide. In other cases, we may not have collected or retained the information. * -**With a court order _or_ a search warrant**: We will not disclose account access logs unless compelled to do so by either +**With a court order _or_ a search warrant:** We will not disclose account access logs unless compelled to do so by either (i) a court order issued under 18 U.S.C. Section 2703(d), upon a showing of specific and articulable facts showing that there are reasonable grounds to believe that the information sought is relevant and material to an ongoing criminal investigation; or (ii) a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures, upon a showing of probable cause. In addition to the non-public account information listed above, we can provide account access logs in response to a court order or search warrant, which may include: @@ -188,7 +188,7 @@ In addition to the non-public account information listed above, we can provide a * Security access logs other than account creation or for a specific time and date * -**Only with a search warrant**: +**Only with a search warrant:** We will not disclose the private contents of any account unless compelled to do so under a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures upon a showing of probable cause. In addition to the non-public account information and account access logs mentioned above, we will also provide private account contents in response to a search warrant, which may include: @@ -199,7 +199,7 @@ In addition to the non-public account information and account access logs mentio * Any security keys used for authentication or encryption * -**Under exigent circumstances**: +**Under exigent circumstances:** If we receive a request for information under certain exigent circumstances (where we believe the disclosure is necessary to prevent an emergency involving danger of death or serious physical injury to a person), we may disclose limited information that we determine necessary to enable law enforcement to address the emergency. For any information beyond that, we would require a subpoena, search warrant, or court order, as described above. For example, we will not disclose contents of private repositories without a search warrant. Before disclosing information, we confirm that the request came from a law enforcement agency, an authority sent an official notice summarizing the emergency, and how the information requested will assist in addressing the emergency. ## Cost reimbursement
- **Included:** Passes when the expected output appears
anywhere in the standard output from the run command- **Exact:** Passes when the expected output is completely identical
to the standard output from the run command- **Regex:** Passes if the regular expression in expected
output matches against the standard output from the run command