From 804bee4406feda91458ed19f0698c5c76a99292c Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Sun, 3 Nov 2024 16:32:49 +0100 Subject: [PATCH] Craft session on alerts (#52586) Co-authored-by: hubwriter --- ...ainer-registry-from-the-docker-registry.md | 20 +++++----- .../about-billing-for-github-codespaces.md | 40 ++++++++++--------- ...king-github-copilot-questions-in-github.md | 10 +++-- .../creating-rulesets-for-a-repository.md | 5 +++ .../codespaces-spending-limit-requirement.md | 6 +-- .../codespaces-unavailable-for-emus.md | 6 +-- .../container-registry-ghes-beta.md | 6 +-- data/reusables/repositories/about-fnmatch.md | 2 - .../rulesets-metadata-restrictions-notes.md | 9 +---- .../repositories/rulesets-metadata-step.md | 6 ++- .../rulesets-unsupported-fnmatch-syntax.md | 6 +-- 11 files changed, 51 insertions(+), 65 deletions(-) diff --git a/content/admin/configuring-packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry.md b/content/admin/configuring-packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry.md index 15dc5206ba..6d233dad6b 100644 --- a/content/admin/configuring-packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry.md +++ b/content/admin/configuring-packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry.md @@ -28,11 +28,7 @@ For more information about configuring {% data variables.product.prodname_regist {% ifversion ghes %} -{% note %} - -**Note**: {% data reusables.package_registry.container-registry-ghes-migration-availability %} - -{% endnote %} +>[!NOTE] {% data reusables.package_registry.container-registry-ghes-migration-availability %} {% endif %} @@ -44,17 +40,19 @@ You can start a migration of all your organizations' Docker images to the {% dat If a site administrator has configured email notifications for {% data variables.location.product_location %}, you will receive an email after the migration is complete. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)." -{% note %} +### During the migration -**Notes**: +During the migration, the CPU and memory usage for your instance will increase. To ensure the performance of the instance for your users, {% data variables.product.company_short %} recommends that you begin a migration during a period of reduced activity. -* During the migration, the CPU and memory usage for your instance will increase. To ensure the performance of the instance for your users, {% data variables.product.company_short %} recommends that you begin a migration during a period of reduced activity. -* During the migration, do not modify settings for your enterprise or run `ghe-config-apply` from an administrative SSH session. These actions will trigger a configuration run, which can restart services and may interrupt the migration. -* After the migration, storage pressure on your instance will increase due to the duplication of image files in the Docker registry and the {% data variables.product.prodname_container_registry %}. A future release of {% data variables.product.product_name %} will remove the duplicated files when all migrations are complete. +>[!WARNING] Do not modify settings for your enterprise or run `ghe-config-apply` from an administrative SSH session. These actions will trigger a configuration run, which can restart services and may interrupt the migration. + +### After the migration + +After the migration, storage pressure on your instance will increase due to the duplication of image files in the Docker registry and the {% data variables.product.prodname_container_registry %}. A future release of {% data variables.product.product_name %} will remove the duplicated files when all migrations are complete. For more information about monitoring the performance and storage of {% data variables.location.product_location %}, see "[AUTOTITLE](/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard)." -{% endnote %} +### Starting a migration {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md b/content/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md index d3b8da713b..50843e5ae4 100644 --- a/content/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md +++ b/content/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md @@ -59,14 +59,23 @@ The following storage and core hours of usage are included, free of charge, for | {% data variables.product.prodname_dotcom %} Free for personal accounts | 15 GB-month | 120 | | {% data variables.product.prodname_dotcom %} Pro | 20 GB-month | 180 | -{% note %} +### Understanding GB-months and core hours -**Notes** +The included usage for personal accounts is measured in GB-months and core hours. -* The GB-month unit of storage is a time-based measurement, 1 GB-month being 1 GB of storage usage for one whole month. The disk space used by all of your codespaces and prebuilds is assessed once an hour and your current GB-month usage is recalculated. Therefore, while you have codespaces and prebuilds, your GB-month usage will increase throughout the month. For example, if the storage totals 15 GB, and remains unchanged throughout your monthly billing cycle, then you will have used 7.5 GB halfway through the month, and 15 GB at the end of the month. See "[About billing for storage usage](#about-billing-for-storage-usage)" later in this article. -* A "core hour" is a measure used for included compute usage. To calculate core hours, multiply the number of hours for which a codespace has been active by the multiplier in the pricing table later in this article. For the basic machine types, the multiplier is the number of processor cores in the machine that hosts the codespace. For example, if you use a 2-core machine for your codespace and it's active for an hour, you have used 2 core hours. If you use an 8-core machine for an hour, you have used 8 core hours. If you use an 8-core machine for two hours, you have used 16 core hours. +#### GB-month -{% endnote %} +The GB-month unit of storage is a time-based measurement, 1 GB-month being 1 GB of storage usage for one whole month. The disk space used by all of your codespaces and prebuilds is assessed once an hour and your current GB-month usage is recalculated. Therefore, while you have codespaces and prebuilds, your GB-month usage will increase throughout the month. For example, if the storage totals 15 GB, and remains unchanged throughout your monthly billing cycle, then you will have used 7.5 GB halfway through the month, and 15 GB at the end of the month. See "[About billing for storage usage](#about-billing-for-storage-usage)" later in this article. + +#### Core hour + +A "core hour" is a measure used for included compute usage. To calculate core hours, multiply the number of hours for which a codespace has been active by the multiplier in the pricing table later in this article. For the basic machine types, the multiplier is the number of processor cores in the machine that hosts the codespace. For example: + +* A 2-core machine used for 1 hour equals 2 core hours +* An 8-core machine used for 1 hour equals 8 core hours +* An 8-core machine used for 2 hours equals 16 core hours + +### Using your included usage You will be notified by email when you have used 75%, 90%, and 100% of your included quotas. Notifications are also displayed in a "toast" message within {% data variables.product.prodname_vscode_shortname %} and the {% data variables.product.prodname_vscode_shortname %} web client. You can turn off email notifications if required. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/managing-the-spending-limit-for-github-codespaces#managing-usage-and-spending-limit-email-notifications)." @@ -123,17 +132,17 @@ You can control compute usage by stopping your codespaces. For information, see For {% data variables.product.prodname_github_codespaces %} billing purposes, storage comprises the disk space used by all of the codespaces and prebuilds in your account. This includes any files you use in a codespace, such as cloned repositories, configuration files, data loaded to the codespace (for example as input or output of the software running in the repository), and extensions, among others. Storage is billed for all of your existing codespaces, regardless of whether they are active or inactive with the exception of blocked usage due to exhausted included usage quota or reaching your spending limit. The storage billing for a codespace ends when it is deleted. However, deleting a codespace does not reduce your used storage amount for the current billing month as this is a cumulative figure. -{% note %} +### Storage billing for containers based on the default image -**Note** +When you use the default dev container configuration, your container is built from the default Linux image for codespaces. See "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)." -When you use the default dev container configuration, your dev container will be built from the default Linux image for codespaces. See "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)." Containers based on the default image are not counted as used storage, irrespective of whether you have added features in your dev container configuration. See "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file)." +Containers based on the default image are not counted as used storage, even if you add features in your dev container configuration. See "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file)." If you use the default image, the storage usage for your codespace will be based on the files in your repository, and any files you subsequently add to the codespace. If you use an alternative base image, then the resulting container and all of the files in the codespace will be counted as used storage. {% data reusables.codespaces.check-for-default-image %} -{% endnote %} +### Reporting storage usage Codespace storage is reported in GB-months. Your billing month runs from a fixed day in one month until the same day in the next month. In most cases the day of the month is determined by the day you started on your current {% data variables.product.prodname_dotcom %} plan. Your GB-month storage is calculated as follows. Once every hour, the storage used by all of your currently active and stopped codespaces is assessed. This figure is then divided by the number of hours in the current billing month: `total storage size / hours this month`. The result is added to the running total for codespace storage for the month. @@ -187,13 +196,9 @@ To limit the storage costs associated with prebuilds, you can choose to create p If you delete a prebuild configuration, all the associated prebuilds are deleted, reducing your storage consumption from that point onward. See "[AUTOTITLE](/codespaces/prebuilding-your-codespaces/managing-prebuilds#deleting-a-prebuild-configuration)." -{% note %} +Prebuilds can be updated multiple times during a billing month. Each update may change the size of the prebuild, which affects your storage charges. For details of how storage is calculated during a billing month, see "[About billing for storage usage](#about-billing-for-storage-usage)" earlier in this article. -**Notes**: -* Prebuilds may be updated several times during a billing month. Newer versions of a prebuild may be larger or smaller than the previous versions. This will affect the storage charges. For details of how storage is calculated during a billing month, see "[About billing for storage usage](#about-billing-for-storage-usage)" earlier in this article. -* As with deleting codespaces, deleting prebuilds does not reduce your used storage amount for the current billing month as this is a cumulative figure. - -{% endnote %} +>[!TIP] As with deleting codespaces, deleting prebuilds does not reduce your used storage amount for the current billing month as this is a cumulative figure. ### Cost of codespaces created from prebuilds @@ -253,16 +258,13 @@ If a user publishes a codespace created from a template, the codespace is publis {% ifversion ghec %} -{% note %} +A {% data variables.enterprise.prodname_managed_user %} cannot be the billable owner of a codespace. Therefore: -**Note:** A {% data variables.enterprise.prodname_managed_user %} cannot be the billable owner of a codespace. Therefore: * A {% data variables.enterprise.prodname_managed_user %} can only create a codespace from a template if the codespace is billed to an organization. * A {% data variables.enterprise.prodname_managed_user %} cannot publish a codespace created from a template to a new repository. See "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." -{% endnote %} - {% endif %} ## What happens when users are removed diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md index f2f2a3e5b1..9254ee6857 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md @@ -72,12 +72,14 @@ The skills you can use in {% data variables.product.prodname_copilot_chat_dotcom {% data reusables.copilot.copilot-chat-models-list %} +### Limitations of AI models for {% data variables.product.prodname_copilot_chat_short %} + +* If you want to use the skills listed in the table above{% ifversion ghec %}, or knowledge bases{% endif %}, on the {% data variables.product.github %} website, you must use the `gpt-4o` model. +* Experimental pre-release versions of the models may not interact with all filters correctly, including the duplication detection filter. + ### Changing your AI model -> [!NOTE] -> * If you want to use the skills listed in the table above{% ifversion ghec %}, or knowledge bases{% endif %}, on the {% data variables.product.github %} website, you must use the `gpt-4o` model. -> * If you use {% data variables.product.prodname_copilot_extensions_short %}, they may override the model you select. -> * Experimental pre-release versions of the models may not interact with all filters correctly, including the duplication detection filter. +> [!NOTE] If you use {% data variables.product.prodname_copilot_extensions_short %}, they may override the model you select. {% data reusables.copilot.model-picker-enable-o1-models %} 1. In the bottom right of any page on {% data variables.product.github %}, click {% octicon "copilot" aria-label="Open Copilot Chat" %}. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md index 1787e463c7..a24ff32104 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md @@ -38,6 +38,11 @@ To import one of the prebuilt rulesets by {% data variables.product.prodname_dot ## Using `fnmatch` syntax {% data reusables.repositories.rulesets-fnmatch %} + +### Unsupported `fnmatch` syntax + +{% data reusables.repositories.rulesets-unsupported-fnmatch-syntax %} + {% ifversion repo-rules-enterprise %} ## Using regular expressions for commit metadata diff --git a/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/data/reusables/codespaces/codespaces-spending-limit-requirement.md index b9d0e07fc5..a34b251d76 100644 --- a/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1,7 +1,3 @@ -{% note %} - -**Note:** You must set a non-zero spending limit on your personal, organization, or enterprise account before the account can be billed for use of {% data variables.product.prodname_github_codespaces %}. - -{% endnote %} +>[!NOTE] You must set a non-zero spending limit on your personal, organization, or enterprise account before the account can be billed for use of {% data variables.product.prodname_github_codespaces %}. By default, all accounts have a {% data variables.product.prodname_github_codespaces %} spending limit of $0 USD. This prevents new codespaces being created, or existing codespaces being opened, if doing so would incur a billable cost to your personal, organization, or enterprise account. For personal accounts, if you have access to create a codespace, you can do so as long as the account has not reached the limit of its monthly included usage. For organizations and enterprises, the default spending limit means that, to allow people to create codespaces that are billed to the organization, or its parent enterprise, the limit must be changed to a value above $0 USD. diff --git a/data/reusables/codespaces/codespaces-unavailable-for-emus.md b/data/reusables/codespaces/codespaces-unavailable-for-emus.md index 6a737cb8ff..6f8c13e10d 100644 --- a/data/reusables/codespaces/codespaces-unavailable-for-emus.md +++ b/data/reusables/codespaces/codespaces-unavailable-for-emus.md @@ -1,5 +1 @@ -{% note %} - -**Note**: {% data variables.product.prodname_github_codespaces %} is not available for repositories that are owned by managed user accounts. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." - -{% endnote %} +>[!NOTE] {% data variables.product.prodname_github_codespaces %} is not available for repositories that are owned by managed user accounts. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." diff --git a/data/reusables/package_registry/container-registry-ghes-beta.md b/data/reusables/package_registry/container-registry-ghes-beta.md index 41277365be..345816a3d5 100644 --- a/data/reusables/package_registry/container-registry-ghes-beta.md +++ b/data/reusables/package_registry/container-registry-ghes-beta.md @@ -1,11 +1,7 @@ {% ifversion ghes %} -{% note %} - -**Note**: {% data variables.product.prodname_container_registry %} is currently in {% data variables.release-phases.public_preview %} for {% data variables.product.product_name %} and subject to change. +>[!NOTE] {% data variables.product.prodname_container_registry %} is currently in {% data variables.release-phases.public_preview %} for {% data variables.product.product_name %} and subject to change. Both {% data variables.product.prodname_registry %} and subdomain isolation must be enabled to use {% data variables.product.prodname_container_registry %}. For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." -{% endnote %} - {% endif %} diff --git a/data/reusables/repositories/about-fnmatch.md b/data/reusables/repositories/about-fnmatch.md index 751ae79e0a..bd3f0a7f91 100644 --- a/data/reusables/repositories/about-fnmatch.md +++ b/data/reusables/repositories/about-fnmatch.md @@ -1,5 +1,3 @@ Because {% data variables.product.company_short %} uses the `File::FNM_PATHNAME` flag for the `File.fnmatch` syntax, the `*` wildcard does not match directory separators (`/`). For example, `qa/*` will match all branches beginning with `qa/` and containing a single slash, but will not match `qa/foo/bar`. You can include any number of slashes after `qa` with `qa/**/*`, which would match, for example, `qa/foo/bar/foobar/hello-world`. You can also extend the `qa` string with `qa**/**/*` to make the rule more inclusive. For more information about syntax options, see the [fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). - -{% data reusables.repositories.rulesets-unsupported-fnmatch-syntax %} diff --git a/data/reusables/repositories/rulesets-metadata-restrictions-notes.md b/data/reusables/repositories/rulesets-metadata-restrictions-notes.md index ccc4a05bd4..75aa039400 100644 --- a/data/reusables/repositories/rulesets-metadata-restrictions-notes.md +++ b/data/reusables/repositories/rulesets-metadata-restrictions-notes.md @@ -1,8 +1 @@ -{% note %} - -**Notes:** -* Adding metadata restrictions can impact the experience of people contributing to your repository. Before you enact a ruleset with metadata restrictions, you can select the "Evaluate" enforcement status for your ruleset to test the effects of any metadata restrictions without impacting contributors. For more information on metadata restrictions, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#important-considerations-for-metadata-restrictions)." -* Metadata restrictions are intended to increase consistency between commits in your repository. They are not intended to replace security measures such as requiring code review via pull requests. -* If you squash merge a branch, all commits on that branch must meet any metadata requirements for the base branch. - -{% endnote %} +> [!NOTE] If you squash merge a branch, all commits on that branch must meet any metadata requirements for the base branch. diff --git a/data/reusables/repositories/rulesets-metadata-step.md b/data/reusables/repositories/rulesets-metadata-step.md index f3c157063a..35971d10f0 100644 --- a/data/reusables/repositories/rulesets-metadata-step.md +++ b/data/reusables/repositories/rulesets-metadata-step.md @@ -1,6 +1,8 @@ +Your metadata restrictions should be intended to increase consistency between commits in your repository. They are not intended to replace security measures such as requiring code review via pull requests. + {% data reusables.repositories.rulesets-metadata-restrictions-notes %} -1. Optionally, to add a rule to control commit metadata or branch names, in the "Restrictions" section, click **Restrict commit metadata** or **Restrict branch names**. +1. To add a rule to control commit metadata or branch names, in the "Restrictions" section when creating or editing a ruleset, click **Restrict commit metadata** or **Restrict branch names**. 1. Configure the settings for the restriction, then click **Add**. You can add multiple restrictions to the same ruleset. 1. To match a given regex pattern, in the "Requirement" dropdown, select **Must match a given regex pattern**. @@ -10,3 +12,5 @@ For more complex patterns, you can select "Must match a given regex pattern" or "Must not match a given regex pattern," then use regular expression syntax to define the matching pattern. For more information, see "[About regular expressions for commit metadata](/enterprise-cloud@latest/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization#using-regular-expressions-for-commit-metadata){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} Anyone who views the rulesets for a repository will be able to see the description you provide. + +1. Optionally, before enacting your ruleset with metadata restrictions, select the "Evaluate" enforcement status for your ruleset to test the effects of any metadata restrictions without impacting contributors. For more information on metadata restrictions, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#important-considerations-for-metadata-restrictions)." diff --git a/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md b/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md index a365d69d29..194e36b9c5 100644 --- a/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md +++ b/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md @@ -1,9 +1,5 @@ -{% note %} - -**Note:** Not all expressions from the `fnmatch` syntax are supported in branch protection rules. Please be aware of the following constraints: +Not all expressions from the `fnmatch` syntax are supported in branch protection rules. Please be aware of the following constraints: * You cannot use the backslash (`\`) character as a quoting character, as {% data variables.product.prodname_dotcom %} does not support the use of backslashes in branch protection rules. * You can specify character sets within square brackets (`[]`), but you cannot currently complement a set with the `^` operator (e.g., `[^charset]`). * Although {% data variables.product.prodname_dotcom %} supports `File::FNM_PATHNAME` in `fnmatch` syntax, `File::FNM_EXTGLOB` is not supported. - -{% endnote %}