From b3707a32bb8bc573c72ecb7995b43e8745f2e57e Mon Sep 17 00:00:00 2001 From: Artur Kordowski <9746197+akordowski@users.noreply.github.com> Date: Tue, 26 Nov 2024 16:45:31 +0100 Subject: [PATCH] Fix text formatting with colon --- .../reusables/actions/about-actions-metrics.md | 4 ++-- data/reusables/actions/add-hosted-runner.md | 18 +++++++++--------- ...enterprise-gcp-storage-credential-fields.md | 6 +++--- ...terprise-minio-storage-credential-fields.md | 6 +++--- .../enterprise-s3-storage-credential-fields.md | 6 +++--- ...-runners-navigate-to-repo-org-enterprise.md | 8 ++++---- ...er-runners-troubleshooting-linux-windows.md | 12 ++++++------ .../actions/org-roles-for-gh-actions.md | 4 ++-- ...d-runner-management-permissions-required.md | 10 +++++----- .../code-scanning/enabling-options.md | 4 ++-- .../codespaces/devcontainer-properties-1.md | 8 ++++---- .../codespaces/devcontainer-properties-2.md | 6 +++--- .../community/types-of-interaction-limits.md | 6 +++--- .../copilot/assess-copilot-suggestion.md | 2 +- .../copilot/copilot-chat-models-list.md | 8 ++++---- data/reusables/copilot/policies-for-dotcom.md | 4 ++-- .../limitations-of-migrated-data.md | 8 ++++---- .../proxy_xff_firewall_warning.md | 2 +- .../pre-defined-organization-roles.md | 12 ++++++------ .../repositories/push-rulesets-overview.md | 8 ++++---- .../rulesets-about-enforcement-statuses.md | 6 +++--- data/reusables/secret-scanning/alert-types.md | 6 +++--- 22 files changed, 77 insertions(+), 77 deletions(-) diff --git a/data/reusables/actions/about-actions-metrics.md b/data/reusables/actions/about-actions-metrics.md index e7eb3ae2dfcf..4cd3ef8e7efe 100644 --- a/data/reusables/actions/about-actions-metrics.md +++ b/data/reusables/actions/about-actions-metrics.md @@ -1,5 +1,5 @@ ## About {% data variables.product.prodname_actions %} metrics {% data variables.product.prodname_actions %} metrics provide insights into how your workflows and jobs are performing at the organization and repository levels. There are two types of metrics to help you analyze different aspects of your workflows: -* **{% data variables.product.prodname_actions %} usage metrics**: Usage metrics help you track how many minutes your workflows and jobs consume. You can use this data to understand the cost of running Actions and ensure you're staying within your plan limits. This is especially useful for identifying high-usage workflows or repositories. -* **{% data variables.product.prodname_actions %} performance metrics**: Performance metrics focus on the efficiency and reliability of your workflows and jobs. With performance metrics, you can monitor key indicators like job run times, queue times, and failure rates to identify bottlenecks, slow-running jobs, or frequently failing workflows. +* **{% data variables.product.prodname_actions %} usage metrics:** Usage metrics help you track how many minutes your workflows and jobs consume. You can use this data to understand the cost of running Actions and ensure you're staying within your plan limits. This is especially useful for identifying high-usage workflows or repositories. +* **{% data variables.product.prodname_actions %} performance metrics:** Performance metrics focus on the efficiency and reliability of your workflows and jobs. With performance metrics, you can monitor key indicators like job run times, queue times, and failure rates to identify bottlenecks, slow-running jobs, or frequently failing workflows. diff --git a/data/reusables/actions/add-hosted-runner.md b/data/reusables/actions/add-hosted-runner.md index 678247bf8699..4c6c2e3b0156 100644 --- a/data/reusables/actions/add-hosted-runner.md +++ b/data/reusables/actions/add-hosted-runner.md @@ -1,15 +1,15 @@ 1. Click **New runner**, then click **{% octicon "mark-github" aria-hidden="true" %} New {% data variables.product.prodname_dotcom %}-hosted runner**. 1. Complete the required details to configure your new runner: - * **Name**: Enter a name for your new runner. For easier identification, this should indicate its hardware and operating configuration, such as `ubuntu-20.04-16core`. - * **Platform**: Choose a platform from the available options. Once you've selected a platform, you will be able to choose a specific image. - * **Image**: Choose an image from the available options. Once you've selected an image, you will be able to choose a specific size. - * **GitHub-owned**: For images managed by GitHub, select an image under this tab. - * **Partner**: For images managed by a partner, select an image under this tab. Windows 11 desktop and GPU-optimized images are located under this tab. - * **Size**: Choose a hardware configuration from the list of available options. The available sizes depend on the image that you selected in a previous step. For GPU runners, select a size under the **GPU-powered** tab. - * **Maximum concurrency**: Choose the maximum number of jobs that can be active at any time. - * **Runner group**: Choose the group that your runner will be a member of. This group will host multiple instances of your runner, as they scale up and down to suit demand. {% ifversion ghec %} - * **Networking**: Choose whether static IP address ranges will be assigned to instances of the {% data variables.actions.hosted_runner %}. You can use up to 10 {% data variables.actions.hosted_runner %}s with static IP addresses in total. {% endif %} + * **Name:** Enter a name for your new runner. For easier identification, this should indicate its hardware and operating configuration, such as `ubuntu-20.04-16core`. + * **Platform:** Choose a platform from the available options. Once you've selected a platform, you will be able to choose a specific image. + * **Image:** Choose an image from the available options. Once you've selected an image, you will be able to choose a specific size. + * **GitHub-owned:** For images managed by GitHub, select an image under this tab. + * **Partner:** For images managed by a partner, select an image under this tab. Windows 11 desktop and GPU-optimized images are located under this tab. + * **Size:** Choose a hardware configuration from the list of available options. The available sizes depend on the image that you selected in a previous step. For GPU runners, select a size under the **GPU-powered** tab. + * **Maximum concurrency:** Choose the maximum number of jobs that can be active at any time. + * **Runner group:** Choose the group that your runner will be a member of. This group will host multiple instances of your runner, as they scale up and down to suit demand. {% ifversion ghec %} + * **Networking:** Choose whether static IP address ranges will be assigned to instances of the {% data variables.actions.hosted_runner %}. You can use up to 10 {% data variables.actions.hosted_runner %}s with static IP addresses in total. {% endif %} {% data reusables.actions.larger-runner-name-note %} diff --git a/data/reusables/actions/enterprise-gcp-storage-credential-fields.md b/data/reusables/actions/enterprise-gcp-storage-credential-fields.md index 67b93bef4832..75d0036d40f4 100644 --- a/data/reusables/actions/enterprise-gcp-storage-credential-fields.md +++ b/data/reusables/actions/enterprise-gcp-storage-credential-fields.md @@ -1,3 +1,3 @@ -* **Service URL**: The service URL for your bucket. This is usually `https://storage.googleapis.com`. -* **Bucket Name**: The name of your bucket. -* **HMAC Access Id** and **HMAC Secret**: The Google Cloud access ID and secret for your storage account. For more information, see "[Manage HMAC keys for service accounts](https://cloud.google.com/storage/docs/authentication/managing-hmackeys)" in the Google Cloud documentation. +* **Service URL:** The service URL for your bucket. This is usually `https://storage.googleapis.com`. +* **Bucket Name:** The name of your bucket. +* **HMAC Access Id and HMAC Secret:** The Google Cloud access ID and secret for your storage account. For more information, see "[Manage HMAC keys for service accounts](https://cloud.google.com/storage/docs/authentication/managing-hmackeys)" in the Google Cloud documentation. diff --git a/data/reusables/actions/enterprise-minio-storage-credential-fields.md b/data/reusables/actions/enterprise-minio-storage-credential-fields.md index 5915bb671ef9..57ed2dfd0896 100644 --- a/data/reusables/actions/enterprise-minio-storage-credential-fields.md +++ b/data/reusables/actions/enterprise-minio-storage-credential-fields.md @@ -1,3 +1,3 @@ -* **AWS Service URL**: The URL to your MinIO service. For example, `https://my-minio.example:9000`. -* **AWS S3 Bucket**: The name of your S3 bucket. -* **AWS S3 Access Key** and **AWS S3 Secret Key**: The `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` used for your MinIO instance. +* **AWS Service URL:** The URL to your MinIO service. For example, `https://my-minio.example:9000`. +* **AWS S3 Bucket:** The name of your S3 bucket. +* **AWS S3 Access Key and AWS S3 Secret Key:** The `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` used for your MinIO instance. diff --git a/data/reusables/actions/enterprise-s3-storage-credential-fields.md b/data/reusables/actions/enterprise-s3-storage-credential-fields.md index 2ec8c89eb79b..a489441ddd1d 100644 --- a/data/reusables/actions/enterprise-s3-storage-credential-fields.md +++ b/data/reusables/actions/enterprise-s3-storage-credential-fields.md @@ -1,5 +1,5 @@ -* **AWS Service URL**: The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2` region, this value should be `https://s3.us-west-2.amazonaws.com`. +* **AWS Service URL:** The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2` region, this value should be `https://s3.us-west-2.amazonaws.com`. For more information, see "[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)" in the AWS documentation. -* **AWS S3 Bucket**: The name of your S3 bucket. -* **AWS S3 Access Key** and **AWS S3 Secret Key**: The AWS access key ID and secret key for your bucket. +* **AWS S3 Bucket:** The name of your S3 bucket. +* **AWS S3 Access Key and AWS S3 Secret Key:** The AWS access key ID and secret key for your bucket. diff --git a/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md b/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md index ce5d1a319223..d9e6ca974da1 100644 --- a/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md +++ b/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md @@ -4,9 +4,9 @@ 1. In the left sidebar, click **Actions**, then click **Runners**. {% elsif ghec %} 1. Navigate to your runner settings: - * **In an organization or repository**: Navigate to the main page, then click **{% octicon "gear" aria-hidden="true" %} Settings**. - * **If using an enterprise account**: Navigate to your enterprise account by clicking your profile photo in the top-right corner of {% data variables.product.github %}, then clicking **Your enterprises**, then clicking the enterprise. + * **In an organization or repository:** Navigate to the main page, then click **{% octicon "gear" aria-hidden="true" %} Settings**. + * **If using an enterprise account:** Navigate to your enterprise account by clicking your profile photo in the top-right corner of {% data variables.product.github %}, then clicking **Your enterprises**, then clicking the enterprise. 1. Navigate to the {% data variables.product.prodname_actions %} settings: - * **In an organization or repository**: Click **Actions** in the left sidebar, then click **Runners**. - * **If using an enterprise account**: In the left sidebar, click **"{% octicon "law" aria-hidden="true" %} Policies"**, then click **Actions**, then click the **Runners** tab. + * **In an organization or repository:** Click **Actions** in the left sidebar, then click **Runners**. + * **If using an enterprise account:** In the left sidebar, click **"{% octicon "law" aria-hidden="true" %} Policies"**, then click **Actions**, then click the **Runners** tab. {% endif %} diff --git a/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md b/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md index c8cf7a0587be..e6f4f9ae0e42 100644 --- a/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md +++ b/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md @@ -1,8 +1,8 @@ If you notice the jobs that target your {% data variables.actions.hosted_runner %}s are delayed or not running, there are several factors that may be causing this. -* **Concurrency settings**: You may have reached your maximum concurrency limit. If you would like to enable more jobs to run in parallel, you can update your autoscaling settings to a larger number. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#configuring-autoscaling-for-larger-runners)." -* **Repository permissions**: Ensure you have the appropriate repository permissions enabled for your {% data variables.actions.hosted_runner %}s. By default, enterprise runners are not available at the repository level and must be manually enabled by an organization administrator. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-larger-runners)." -* **Billing information**: You must have a valid credit card on file in order to use {% data variables.actions.hosted_runner %}s. After adding a credit card to your account, it can take up to 10 minutes to enable the use of your {% data variables.actions.hosted_runner %}s. For more information, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)." -* **Spending limit**: Your {% data variables.product.prodname_actions %} spending limit must be set to a value greater than zero. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions)." -* **Fair use policy**: {% data variables.product.company_short %} has a fair use policy that begins to throttle jobs based on several factors, such as how many jobs you are running or how many jobs are running across the entirety of {% data variables.product.prodname_actions %}. -* **Job queue to assign time**: Job queue to assign time refers to the time between a job request and {% data variables.product.company_short %} assigning a VM to execute the job. Standard {% data variables.product.company_short %}-hosted runners utilizing prescribed YAML workflow labels (such as `ubuntu-latest`) are always in a "warm" state. With larger runners, a warm machine may not be ready to pick up a job on first request as the pools for these machines are smaller. As a result, {% data variables.product.company_short %} may need to create a new VM, which increases the queue to assign time. Once a runner is in use, VMs are readily for subsequent workflow runs, reducing the queue to assign time for future workflow runs over the next 24 hours. +* **Concurrency settings:** You may have reached your maximum concurrency limit. If you would like to enable more jobs to run in parallel, you can update your autoscaling settings to a larger number. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#configuring-autoscaling-for-larger-runners)." +* **Repository permissions:** Ensure you have the appropriate repository permissions enabled for your {% data variables.actions.hosted_runner %}s. By default, enterprise runners are not available at the repository level and must be manually enabled by an organization administrator. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-larger-runners)." +* **Billing information:** You must have a valid credit card on file in order to use {% data variables.actions.hosted_runner %}s. After adding a credit card to your account, it can take up to 10 minutes to enable the use of your {% data variables.actions.hosted_runner %}s. For more information, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)." +* **Spending limit:** Your {% data variables.product.prodname_actions %} spending limit must be set to a value greater than zero. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions)." +* **Fair use policy:** {% data variables.product.company_short %} has a fair use policy that begins to throttle jobs based on several factors, such as how many jobs you are running or how many jobs are running across the entirety of {% data variables.product.prodname_actions %}. +* **Job queue to assign time:** Job queue to assign time refers to the time between a job request and {% data variables.product.company_short %} assigning a VM to execute the job. Standard {% data variables.product.company_short %}-hosted runners utilizing prescribed YAML workflow labels (such as `ubuntu-latest`) are always in a "warm" state. With larger runners, a warm machine may not be ready to pick up a job on first request as the pools for these machines are smaller. As a result, {% data variables.product.company_short %} may need to create a new VM, which increases the queue to assign time. Once a runner is in use, VMs are readily for subsequent workflow runs, reducing the queue to assign time for future workflow runs over the next 24 hours. diff --git a/data/reusables/actions/org-roles-for-gh-actions.md b/data/reusables/actions/org-roles-for-gh-actions.md index ba6be335f2b2..b95401086cdb 100644 --- a/data/reusables/actions/org-roles-for-gh-actions.md +++ b/data/reusables/actions/org-roles-for-gh-actions.md @@ -2,5 +2,5 @@ For {% data variables.product.prodname_actions %}, you can enable any of the fol * **Manage organization Actions policies:** Access to manage all settings on the "Actions General" settings page, except for self-hosted runners settings. * **Manage organization runners and runner groups:** Access to create and manage GitHub-hosted runners, self-hosted runners, and runner groups, and control where self-hosted runners can be created. -* **Manage organization Actions secrets**: Access to create and manage Actions organization secrets. -* **Manage organization Actions variables**: Access to create and manage Actions organization variables. +* **Manage organization Actions secrets:** Access to create and manage Actions organization secrets. +* **Manage organization Actions variables:** Access to create and manage Actions organization variables. diff --git a/data/reusables/actions/self-hosted-runner-management-permissions-required.md b/data/reusables/actions/self-hosted-runner-management-permissions-required.md index db0e353bbed5..b91f29948519 100644 --- a/data/reusables/actions/self-hosted-runner-management-permissions-required.md +++ b/data/reusables/actions/self-hosted-runner-management-permissions-required.md @@ -1,9 +1,9 @@ A self-hosted runner can be located in either your repository, organization, or {% ifversion fpt or ghec %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif ghes %} enterprise settings on {% data variables.product.prodname_ghe_server %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: -* **User repository**: You must be the repository owner. -* **Organization**: You must be an organization owner. -* **Organization repository**: You must be an organization owner, or have admin access to the repository. +* **User repository:** You must be the repository owner. +* **Organization:** You must be an organization owner. +* **Organization repository:** You must be an organization owner, or have admin access to the repository. {% ifversion ghec %} -* **Enterprise account**: You must be an enterprise owner. +* **Enterprise account:** You must be an enterprise owner. {% elsif ghes %} -* **Enterprise**: You must be a {% data variables.product.prodname_enterprise %} site administrator. +* **Enterprise:** You must be a {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/code-scanning/enabling-options.md b/data/reusables/code-scanning/enabling-options.md index 0c13aec193bd..69ab845cced5 100644 --- a/data/reusables/code-scanning/enabling-options.md +++ b/data/reusables/code-scanning/enabling-options.md @@ -1,2 +1,2 @@ -* **{% data variables.product.prodname_codeql %}**: Uses {% data variables.product.prodname_actions %} with either default setup (see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)") or advanced setup (see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-advanced-setup-for-code-scanning-with-codeql)"), or runs {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system)"). -* **Third‑party**: Uses {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %}(see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-workflows)") {% endif %}or third-party tools and uploads results to {% data variables.product.product_name %} (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)"). +* **{% data variables.product.prodname_codeql %}:** Uses {% data variables.product.prodname_actions %} with either default setup (see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)") or advanced setup (see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-advanced-setup-for-code-scanning-with-codeql)"), or runs {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system)"). +* **Third‑party:** Uses {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %}(see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-workflows)") {% endif %}or third-party tools and uploads results to {% data variables.product.product_name %} (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)"). diff --git a/data/reusables/codespaces/devcontainer-properties-1.md b/data/reusables/codespaces/devcontainer-properties-1.md index 4af2abd60b2d..23a037fc65ed 100644 --- a/data/reusables/codespaces/devcontainer-properties-1.md +++ b/data/reusables/codespaces/devcontainer-properties-1.md @@ -1,4 +1,4 @@ -* **name**: You can name your dev container anything you want. A default value is supplied. -* **image**: The name of an image in a container registry ([DockerHub](https://hub.docker.com/), [{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %}](/packages/learn-github-packages/introduction-to-github-packages), or [Azure Container Registry](https://azure.microsoft.com/services/container-registry/)) that will be used to create the dev container for the codespace. -* **features**: A list of one or more objects, each of which references one of the available dev container features. Features are self-contained, shareable units of installation code and development container configuration. They provide an easy way to add more tooling, runtime, or library features to your development container. You can add features either within {% data variables.product.prodname_vscode_shortname %} or in the `devcontainer.json` editor on {% data variables.product.github %}. For more information, click either the **{% data variables.product.prodname_vscode %}** or **Web browser** tab in "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)." -* **forwardPorts**: Any ports listed here will be forwarded automatically. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +* **name:** You can name your dev container anything you want. A default value is supplied. +* **image:** The name of an image in a container registry ([DockerHub](https://hub.docker.com/), [{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %}](/packages/learn-github-packages/introduction-to-github-packages), or [Azure Container Registry](https://azure.microsoft.com/services/container-registry/)) that will be used to create the dev container for the codespace. +* **features:** A list of one or more objects, each of which references one of the available dev container features. Features are self-contained, shareable units of installation code and development container configuration. They provide an easy way to add more tooling, runtime, or library features to your development container. You can add features either within {% data variables.product.prodname_vscode_shortname %} or in the `devcontainer.json` editor on {% data variables.product.github %}. For more information, click either the **{% data variables.product.prodname_vscode %}** or **Web browser** tab in "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)." +* **forwardPorts:** Any ports listed here will be forwarded automatically. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." diff --git a/data/reusables/codespaces/devcontainer-properties-2.md b/data/reusables/codespaces/devcontainer-properties-2.md index 3cc1a08a6ffb..a1a9b6c8d177 100644 --- a/data/reusables/codespaces/devcontainer-properties-2.md +++ b/data/reusables/codespaces/devcontainer-properties-2.md @@ -1,3 +1,3 @@ -* **postCreateCommand**: Use this property to run commands after your codespace is created. This can be formatted as a string (as above), an array, or an object. For more information, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. -* **customizations**: This property allows you to customize a specific tool or service when it is used for working in a codespace. For example, you can configure specific settings and extensions for {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Supporting tools and services](https://containers.dev/supporting)" on the Development Containers website. -* **remoteUser**: By default, you’re running as the vscode user, but you can optionally set this to root. +* **postCreateCommand:** Use this property to run commands after your codespace is created. This can be formatted as a string (as above), an array, or an object. For more information, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. +* **customizations:** This property allows you to customize a specific tool or service when it is used for working in a codespace. For example, you can configure specific settings and extensions for {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Supporting tools and services](https://containers.dev/supporting)" on the Development Containers website. +* **remoteUser:** By default, you’re running as the vscode user, but you can optionally set this to root. diff --git a/data/reusables/community/types-of-interaction-limits.md b/data/reusables/community/types-of-interaction-limits.md index 4f74190474eb..a841be827cab 100644 --- a/data/reusables/community/types-of-interaction-limits.md +++ b/data/reusables/community/types-of-interaction-limits.md @@ -1,4 +1,4 @@ There are three types of interaction limits. -* **Limit to existing users**: Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators. -* **Limit to prior contributors**: Limits activity for users who have not previously contributed to the default branch of the repository and are not collaborators. -* **Limit to repository collaborators**: Limits activity for users who do not have write access to the repository. +* **Limit to existing users:** Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators. +* **Limit to prior contributors:** Limits activity for users who have not previously contributed to the default branch of the repository and are not collaborators. +* **Limit to repository collaborators:** Limits activity for users who do not have write access to the repository. diff --git a/data/reusables/copilot/assess-copilot-suggestion.md b/data/reusables/copilot/assess-copilot-suggestion.md index b25c7eeb256e..ba3471702815 100644 --- a/data/reusables/copilot/assess-copilot-suggestion.md +++ b/data/reusables/copilot/assess-copilot-suggestion.md @@ -1,4 +1,4 @@ 1. Assess {% data variables.product.prodname_copilot_short %}'s suggestion and, if you agree with the change: * **In {% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %}:** Click **Accept**. - * **In JetBrains**: Click the Preview icon (double arrows), then click the Apply All Diffs icon (double angle brackets). + * **In JetBrains:** Click the Preview icon (double arrows), then click the Apply All Diffs icon (double angle brackets). diff --git a/data/reusables/copilot/copilot-chat-models-list.md b/data/reusables/copilot/copilot-chat-models-list.md index d5b89de8cb58..f1332fa58307 100644 --- a/data/reusables/copilot/copilot-chat-models-list.md +++ b/data/reusables/copilot/copilot-chat-models-list.md @@ -1,9 +1,9 @@ The following models are currently available through multi-model {% data variables.product.prodname_copilot_chat_short %}: -* **GPT 4o**: This is the default {% data variables.product.prodname_copilot_chat_short %} model. It is a versatile, multimodal model that excels in both text and image processing and is designed to provide fast, reliable responses. It also has superior performance in non-English languages. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/gpt-4o) and review the [model card](https://openai.com/index/gpt-4o-system-card/). Gpt-4o is hosted on Azure. -* **{% data variables.copilot.copilot_claude_sonnet %}**: This model excels at coding tasks across the entire software development lifecycle, from initial design to bug fixes, maintenance to optimizations. Learn more about the [model's capabilities](https://www.anthropic.com/claude/sonnet) or read the [model card](https://assets.anthropic.com/m/61e7d27f8c8f5919/original/Claude-3-Model-Card.pdf). {% data variables.product.prodname_copilot %} uses {% data variables.copilot.copilot_claude_sonnet %} hosted on Amazon Web Services. -* **o1-preview**: This model is focused on advanced reasoning and solving complex problems, in particular in math and science. It responds more slowly than the `gpt-4o` model. You can make 10 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). o1-preview is hosted on Azure. -* **o1-mini**: This is the faster version of the `o1-preview` model, balancing the use of complex reasoning with the need for faster responses. It is best suited for code generation and small context operations. You can make 50 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). o1-mini is hosted on Azure. +* **GPT 4o:** This is the default {% data variables.product.prodname_copilot_chat_short %} model. It is a versatile, multimodal model that excels in both text and image processing and is designed to provide fast, reliable responses. It also has superior performance in non-English languages. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/gpt-4o) and review the [model card](https://openai.com/index/gpt-4o-system-card/). Gpt-4o is hosted on Azure. +* **{% data variables.copilot.copilot_claude_sonnet %}:** This model excels at coding tasks across the entire software development lifecycle, from initial design to bug fixes, maintenance to optimizations. Learn more about the [model's capabilities](https://www.anthropic.com/claude/sonnet) or read the [model card](https://assets.anthropic.com/m/61e7d27f8c8f5919/original/Claude-3-Model-Card.pdf). {% data variables.product.prodname_copilot %} uses {% data variables.copilot.copilot_claude_sonnet %} hosted on Amazon Web Services. +* **o1-preview:** This model is focused on advanced reasoning and solving complex problems, in particular in math and science. It responds more slowly than the `gpt-4o` model. You can make 10 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). o1-preview is hosted on Azure. +* **o1-mini:** This is the faster version of the `o1-preview` model, balancing the use of complex reasoning with the need for faster responses. It is best suited for code generation and small context operations. You can make 50 requests to this model per day. Learn more about the [model's capabilities](https://platform.openai.com/docs/models/o1) and review the [model card](https://openai.com/index/openai-o1-system-card/). o1-mini is hosted on Azure. For more information about the o1 models, see [Models](https://platform.openai.com/docs/models/models) in the OpenAI Platform documentation. diff --git a/data/reusables/copilot/policies-for-dotcom.md b/data/reusables/copilot/policies-for-dotcom.md index 4b7869d38904..965cd9a678da 100644 --- a/data/reusables/copilot/policies-for-dotcom.md +++ b/data/reusables/copilot/policies-for-dotcom.md @@ -1,5 +1,5 @@ -* **Opt in to user feedback collection**: If enabled, users can provide feedback on {% data variables.product.prodname_copilot_short %} pull request summaries. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)." -* **Opt in to preview features**: If enabled, users can test new {% data variables.product.prodname_copilot_short %} features that are not yet generally available. Be aware that previews of features may have flaws, and the features may be changed or discontinued at any time. Current previews of {% data variables.product.prodname_copilot_short %} features include: +* **Opt in to user feedback collection:** If enabled, users can provide feedback on {% data variables.product.prodname_copilot_short %} pull request summaries. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)." +* **Opt in to preview features:** If enabled, users can test new {% data variables.product.prodname_copilot_short %} features that are not yet generally available. Be aware that previews of features may have flaws, and the features may be changed or discontinued at any time. Current previews of {% data variables.product.prodname_copilot_short %} features include: * {% data variables.product.prodname_copilot_autocomplete_pr %}. See "[AUTOTITLE](/copilot/using-github-copilot/using-copilot-text-completion)." * Asking {% data variables.product.prodname_copilot_short %} why a workflow has failed. See "[AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#ask-why-a-workflow-has-failed)." diff --git a/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md b/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md index 63034fdd8c5d..14c85b86cecd 100644 --- a/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md +++ b/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md @@ -9,9 +9,9 @@ There are limits to what {% data variables.product.prodname_importer_proper_name ### Limitations of {% data variables.product.prodname_importer_proper_name %} * **10 GB size limit for a Git repository:** This limit only applies to the source code. To check if the repository archive is over the limit, use the [git-sizer](https://github.com/github/git-sizer) tool and review the total blob size in the output. The git-sizer tool also helps to identify potential issues related to large files, blob size, commit size, and tree counts that could impact migrations. -* **10 GB limit for metadata**: The {% data variables.product.prodname_importer_secondary_name %} cannot migrate repositories with more than 10 GB of metadata. Metadata includes issues, pull requests, releases, and attachments. In most cases, large metadata is caused by binary assets attached to releases. You can exclude releases from the migration with the `migrate-repo` command's `--skip-releases` flag, and then move your releases manually after the migration. -* **{% data variables.large_files.product_name_short %} objects not migrated**: The {% data variables.product.prodname_importer_secondary_name %} can migrate repositories that use {% data variables.large_files.product_name_short %}, but the LFS objects themselves will not be migrated. They can be pushed to your migration destination as a follow-up task after the migration is complete. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects)." +* **10 GB limit for metadata:** The {% data variables.product.prodname_importer_secondary_name %} cannot migrate repositories with more than 10 GB of metadata. Metadata includes issues, pull requests, releases, and attachments. In most cases, large metadata is caused by binary assets attached to releases. You can exclude releases from the migration with the `migrate-repo` command's `--skip-releases` flag, and then move your releases manually after the migration. +* **{% data variables.large_files.product_name_short %} objects not migrated:** The {% data variables.product.prodname_importer_secondary_name %} can migrate repositories that use {% data variables.large_files.product_name_short %}, but the LFS objects themselves will not be migrated. They can be pushed to your migration destination as a follow-up task after the migration is complete. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects)." * **Follow-up tasks required:** When migrating between {% data variables.product.prodname_dotcom %} products, certain settings are not migrated and must be reconfigured in the new repository. For a list of follow-up tasks you'll need to complete after each migration, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#completing-follow-up-tasks)." * **Delayed code search functionality:** Re-indexing the search index can take a few hours after a repository is migrated, and code searches may return unexpected results until re-indexing is complete. -* **Rulesets configured for your organization can cause migrations to fail**: For example, if you configured a rule that requires email addresses for commit authors to end with `@monalisa.cat`, and the repository you're migrating contains commits that don't comply with this rule, your migration will fail. For more information about rulesets, see "[AUTOTITLE](/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." -* **Mannequin content might not be searchable**: Mannequins are placeholder users to which imported content (such as issues, pull requests, comments, etc.) is associated. When you search for content associated with a mannequin, such as assigned issues, the issues may not be found. Once a mannequin is reclaimed, the content should be found via the new owner. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer)." +* **Rulesets configured for your organization can cause migrations to fail:** For example, if you configured a rule that requires email addresses for commit authors to end with `@monalisa.cat`, and the repository you're migrating contains commits that don't comply with this rule, your migration will fail. For more information about rulesets, see "[AUTOTITLE](/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." +* **Mannequin content might not be searchable:** Mannequins are placeholder users to which imported content (such as issues, pull requests, comments, etc.) is associated. When you search for content associated with a mannequin, such as assigned issues, the issues may not be found. Once a mannequin is reclaimed, the content should be found via the new owner. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer)." diff --git a/data/reusables/enterprise_clustering/proxy_xff_firewall_warning.md b/data/reusables/enterprise_clustering/proxy_xff_firewall_warning.md index bf524e760b4a..3328f075d787 100644 --- a/data/reusables/enterprise_clustering/proxy_xff_firewall_warning.md +++ b/data/reusables/enterprise_clustering/proxy_xff_firewall_warning.md @@ -1,5 +1,5 @@ {% danger %} -**Security Warning**: When either PROXY support or HTTP forwarding is enabled, it is critical that no external traffic can directly reach the {% data variables.product.prodname_ghe_server %} appliances. If external traffic is not properly blocked, the source IP addresses can be forged. +**Security Warning:** When either PROXY support or HTTP forwarding is enabled, it is critical that no external traffic can directly reach the {% data variables.product.prodname_ghe_server %} appliances. If external traffic is not properly blocked, the source IP addresses can be forged. {% enddanger %} diff --git a/data/reusables/organizations/pre-defined-organization-roles.md b/data/reusables/organizations/pre-defined-organization-roles.md index 6981b8661440..61238e53f370 100644 --- a/data/reusables/organizations/pre-defined-organization-roles.md +++ b/data/reusables/organizations/pre-defined-organization-roles.md @@ -2,11 +2,11 @@ Pre-defined organization roles are roles that are available by default in every The current set of pre-defined roles are: -* **All-repository read**: Grants read access to all repositories in the organization. -* **All-repository write**: Grants write access to all repositories in the organization. -* **All-repository triage**: Grants triage access to all repositories in the organization. -* **All-repository maintain**: Grants maintenance access to all repositories in the organization. -* **All-repository admin**: Grants admin access to all repositories in the organization. +* **All-repository read:** Grants read access to all repositories in the organization. +* **All-repository write:** Grants write access to all repositories in the organization. +* **All-repository triage:** Grants triage access to all repositories in the organization. +* **All-repository maintain:** Grants maintenance access to all repositories in the organization. +* **All-repository admin:** Grants admin access to all repositories in the organization. {%- ifversion fpt or ghec or ghes > 3.15 %} -* **CI/CD admin**: Grants admin access to manage Actions policies, runners, runner groups, hosted compute network configurations, secrets, variables, and usage metrics for an organization. +* **CI/CD admin:** Grants admin access to manage Actions policies, runners, runner groups, hosted compute network configurations, secrets, variables, and usage metrics for an organization. {%- endif %} diff --git a/data/reusables/repositories/push-rulesets-overview.md b/data/reusables/repositories/push-rulesets-overview.md index 5bda4ef41bda..850562a79050 100644 --- a/data/reusables/repositories/push-rulesets-overview.md +++ b/data/reusables/repositories/push-rulesets-overview.md @@ -4,12 +4,12 @@ Push rules do not require any branch targeting because they apply to every push Push rulesets allow you to: -* **Restrict file paths**: Prevent commits that include changes in specified file paths from being pushed. +* **Restrict file paths:** Prevent commits that include changes in specified file paths from being pushed. {% data reusables.repositories.rulesets-push-rules-path-example %} -* **Restrict file path length**: Prevent commits that include file paths that exceed a specified character limit from being pushed. -* **Restrict file extensions**: Prevent commits that include files with specified file extensions from being pushed. -* **Restrict file size**: Prevent commits that exceed a specified file size limit from being pushed. +* **Restrict file path length:** Prevent commits that include file paths that exceed a specified character limit from being pushed. +* **Restrict file extensions:** Prevent commits that include files with specified file extensions from being pushed. +* **Restrict file size:** Prevent commits that exceed a specified file size limit from being pushed. #### About push rulesets for forked repositories diff --git a/data/reusables/repositories/rulesets-about-enforcement-statuses.md b/data/reusables/repositories/rulesets-about-enforcement-statuses.md index 7daf16dbd8f6..32ef826e835f 100644 --- a/data/reusables/repositories/rulesets-about-enforcement-statuses.md +++ b/data/reusables/repositories/rulesets-about-enforcement-statuses.md @@ -2,9 +2,9 @@ While creating or editing your ruleset, you can use enforcement statuses to conf You can select any of the following enforcement statuses for your ruleset. - * **{% octicon "play" aria-hidden="true" %} Active**: your ruleset will be enforced upon creation.{% ifversion repo-rules-enterprise %} - * **{% octicon "meter" aria-hidden="true" %} Evaluate**: your ruleset will not be enforced, but you will be able to monitor which actions would or would not violate rules on the "Rule Insights" page.{% endif %} - * **{% octicon "skip" aria-hidden="true" %} Disabled**: your ruleset will not be enforced{% ifversion repo-rules-enterprise %} or evaluated{% endif %}. + * **{% octicon "play" aria-hidden="true" %} Active:** your ruleset will be enforced upon creation.{% ifversion repo-rules-enterprise %} + * **{% octicon "meter" aria-hidden="true" %} Evaluate:** your ruleset will not be enforced, but you will be able to monitor which actions would or would not violate rules on the "Rule Insights" page.{% endif %} + * **{% octicon "skip" aria-hidden="true" %} Disabled:** your ruleset will not be enforced{% ifversion repo-rules-enterprise %} or evaluated{% endif %}. {% ifversion repo-rules-enterprise %} diff --git a/data/reusables/secret-scanning/alert-types.md b/data/reusables/secret-scanning/alert-types.md index 9a7b0cdbceef..1f8ab4d7dbcd 100644 --- a/data/reusables/secret-scanning/alert-types.md +++ b/data/reusables/secret-scanning/alert-types.md @@ -1,5 +1,5 @@ There are {% ifversion fpt or ghec %}three{% else %}two{% endif %} types of {% data variables.secret-scanning.alerts %}: -* **{% ifversion fpt or ghec %}User alerts{% else %}{% data variables.secret-scanning.alerts_caps %}{% endif %}**: Reported to users in the **Security** tab of the repository, when a supported secret is detected in the repository. -* **Push protection alerts**: Reported to users in the **Security** tab of the repository, when a contributor bypasses push protection. {% ifversion fpt or ghec %} -* **Partner alerts**: Reported directly to secret providers that are part of {% data variables.product.prodname_secret_scanning %}'s partner program. These alerts are not reported in the **Security** tab of the repository.{% endif %} +* **{% ifversion fpt or ghec %}User alerts{% else %}{% data variables.secret-scanning.alerts_caps %}{% endif %}:** Reported to users in the **Security** tab of the repository, when a supported secret is detected in the repository. +* **Push protection alerts:** Reported to users in the **Security** tab of the repository, when a contributor bypasses push protection. {% ifversion fpt or ghec %} +* **Partner alerts:** Reported directly to secret providers that are part of {% data variables.product.prodname_secret_scanning %}'s partner program. These alerts are not reported in the **Security** tab of the repository.{% endif %}