Skip to content

Commit

Permalink
Merge pull request #35960 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jan 16, 2025
2 parents 59e1113 + c86be62 commit 9a1c3b0
Show file tree
Hide file tree
Showing 69 changed files with 101 additions and 180 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You can also view whether an enterprise owner has a specific role in the organiz
| Enterprise owner | Organization owner | Able to configure organization settings and manage access to the organization's resources through teams, etc. |
| Enterprise owner | Organization member | Able to access organization resources and content, such as repositories, without access to the organization's settings. |

To review all roles in an organization, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization). {% ifversion custom-repository-roles %} An organization member can also have a custom role for a specific repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %}
To review all roles in an organization, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization). {% ifversion ghec or ghes %} An organization member can also have a custom role for a specific repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %}

For more information about the enterprise owner role, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -617,12 +617,10 @@ $ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-cluster-maintenance -u
# Unsets maintenance mode
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,11 @@ You can perform initial validation of your maintenance operation by configuring
1. In the top navigation bar, click **Maintenance**.

![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Maintenance", is highlighted with an orange outline.](/assets/images/enterprise/management-console/maintenance-tab.png)
1. Under "Enable and schedule", {% ifversion custom-maintenance-mode-message %}select **Enable maintenance mode**, then {% endif %}decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time.
1. Under "Enable and schedule", select **Enable maintenance mode**, then decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time.
* To enable maintenance mode immediately, select the dropdown menu and click **now**.
* To schedule a maintenance window for a future time, select the dropdown menu and click a start time.
{% data reusables.enterprise_management_console.custom-maintenance-message %}
{% ifversion custom-maintenance-mode-message %}1. When you're satisfied with the timing of the window and the optional message, click **Save**. If you selected "now", your instance will be put into maintenance mode immediately.
{% else %}1. When you're satisfied with the timing of the window, select the checkbox next to "Enable maintenance mode". If you selected "now", your instance will be put into maintenance mode immediately.{% endif %}
1. When you're satisfied with the timing of the window and the optional message, click **Save**. If you selected "now", your instance will be put into maintenance mode immediately.

{% ifversion ip-exception-list %}

Expand Down Expand Up @@ -103,8 +102,6 @@ For more information, see [AUTOTITLE](/admin/administering-your-instance/adminis

{% endif %}

{% ifversion custom-maintenance-mode-message %}

## Managing maintenance mode using SSH

If you have SSH access, you can use the `ghe-maintenance` command line utility to can set or unset maintenance mode for a {% data variables.product.product_name %} instance with one node, or multiple nodes in a high-availability configuration. For more information, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh) and [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-maintenance).
Expand All @@ -120,14 +117,10 @@ $ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-cluster-maintenance -u
# Unsets maintenance mode
```

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -107,28 +107,17 @@ Each time a user sees a mandatory message, an audit log event is created. The ev

You can set a global announcement banner to be displayed to all users at the top of every page{% ifversion ghec %} within your enterprise, including every page in every organization owned by the enterprise{% endif %}.

{% ifversion custom-banner-messages %}
You can also create announcement banners at the organization level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization).{% endif %}
You can also create announcement banners at the organization level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization).

{% ifversion ghes %}
You can also set an announcement banner{% ifversion ghes %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% ifversion ghes %}[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-announce) and {% endif %}[AUTOTITLE](/rest/enterprise-admin#announcements).
{% endif %}

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}{% ifversion custom-banner-messages %}{% else %}
1. To the right of "Announcement", click **Add announcement**.{% endif %}
1. Under "Announcement", in the text field, type the announcement you want displayed in a banner.
1. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date.
{% ifversion ghe-announce-dismiss %}

> [!NOTE]
> Announcements must either have an expiration date, be user dismissible, or both.
{% endif %}
{% data reusables.enterprise-accounts.messages-tab %}
{%- ifversion ghe-announce-dismiss %}
1. Optionally, to allow each user to dismiss the announcement, select **User dismissible**.
{%- endif %}{% ifversion custom-banner-messages %}
1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**.
{%- endif %}
1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**.
{% data reusables.enterprise_site_admin_settings.message-preview-save %}
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,17 @@ After you authenticate to perform a sensitive action, your session is temporaril

## Confirming access for sudo mode

To confirm access for sudo mode, you {% ifversion totp-and-mobile-sudo-challenge %}can{% else %}must{% endif %} authenticate with your password.{% ifversion totp-and-mobile-sudo-challenge %} Optionally, you can use a different authentication method, like {% ifversion passkeys %}a passkey, {% endif %}{% ifversion fpt or ghec %}a security key, {% data variables.product.prodname_mobile %}, or a 2FA code{% elsif ghes %}a security key or a 2FA code{% endif %}.{% endif %}
To confirm access for sudo mode, you can authenticate with your password. Optionally, you can use a different authentication method, like {% ifversion passkeys %}a passkey, {% endif %}{% ifversion fpt or ghec %}a security key, {% data variables.product.prodname_mobile %}, or a 2FA code{% elsif ghes %}a security key or a 2FA code{% endif %}.

{%- ifversion passkeys %}
* [Confirming access using a passkey key](#confirming-access-using-a-passkey)
{%- endif %}
{%- ifversion totp-and-mobile-sudo-challenge %}
* [Confirming access using a security key](#confirming-access-using-a-security-key)
{%- ifversion fpt or ghec %}
* [Confirming access using GitHub Mobile](#confirming-access-using-github-mobile)
{%- endif %}
* [Confirming access using a 2FA code](#confirming-access-using-a-2fa-code)
* [Confirming access using your password](#confirming-access-using-your-password)
{%- endif %}

{% ifversion passkeys %}

Expand All @@ -63,8 +61,6 @@ To confirm access for sudo mode, you {% ifversion totp-and-mobile-sudo-challenge
You must have a passkey registered to your account to confirm access to your account for sudo mode using a passkey. See [AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys).
{% endif %}

{% ifversion totp-and-mobile-sudo-challenge %}

### Confirming access using a security key

You must configure two-factor authentication (2FA) for your account using a security key to confirm access to your account for sudo mode using the security key. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key).
Expand Down Expand Up @@ -94,6 +90,4 @@ When prompted to authenticate for sudo mode, type the authentication code from y

### Confirming access using your password

{% endif %}

When prompted to authenticate for sudo mode, type your password, then click **Confirm**.
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ To sign commits associated with your account on {% data variables.product.produc

You can add multiple public keys to your account on {% data variables.product.product_name %}. Commits signed by any of the corresponding private keys will show as verified. {% ifversion persistent-commit-verification %}Once a commit has been verified, any commits signed by the corresponding private key will continue to show as verified, even if the public key is removed.{% else %}If you remove a public key, any commits signed by the corresponding private key will no longer show as verified.{% endif %}

![Screenshot of a list of commits. One commit is marked with a "Verified" label. Next to the label, a dropdown explains that the commit was signed and shows a timestamp of when it was signed.](/assets/images/help/settings/verified-persistent-commit.png)
![Screenshot of a list of commits. One commit is marked as "Verified." A dropdown shows the commit was signed and when it was signed.](/assets/images/help/settings/verified-persistent-commit.png)

{% ifversion upload-expired-or-revoked-gpg-key %}
To verify as many of your commits as possible, you can add expired and revoked keys. If the key meets all other verification requirements, commits that were previously signed by any of the corresponding private keys will show as verified and indicate that their signing key is expired or revoked.{% endif %}
To verify as many of your commits as possible, you can add expired and revoked keys. If the key meets all other verification requirements, commits that were previously signed by any of the corresponding private keys will show as verified and indicate that their signing key is expired or revoked.

{% data reusables.gpg.supported-gpg-key-algorithms %}

Expand All @@ -45,20 +44,6 @@ When verifying a signature, {% data variables.product.product_name %} extracts t
1. Click **Add GPG key**.
1. If prompted, authenticate to your {% data variables.product.prodname_dotcom %} account to confirm the action.

{% ifversion upload-expired-or-revoked-gpg-key %}
{% else %}

## Updating an expired GPG key

When verifying a signature, {% data variables.product.product_name %} checks that the key is not revoked or expired. If your signing key is revoked or expired, {% data variables.product.product_name %} cannot verify your signatures.

If your key is expired, you must [update its expiration](https://www.gnupg.org/gph/en/manual.html#AEN329), export the new key, delete the expired key in your account on {% data variables.product.product_name %}, and add the new key to your account as described above. Your previous commits and tags will show as verified, as long as the key meets all other verification requirements.

If your key is revoked, use the primary key or another key that is not revoked to sign your commits.

If your key is invalid and you don't use another valid key in your key set, but instead generate a new GPG key with a new set of credentials, then your commits made with the revoked or expired key will continue to show as unverified. Also, your new credentials will not be able to re-sign or verify your old commits and tags.
{% endif %}

## Further reading

* [AUTOTITLE](/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Each license for {% data variables.product.prodname_GH_advanced_security %} spec
1. Under "Committers", click **Manage committers**.
1. Under "Total committers", click the plus or minus buttons to add or remove committers.

![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} committers screen. A text box with the number 5, a minus button on its left, and a plus button on its right, are highlighted in an orange outline.](/assets/images/help/enterprises/ghas-add-committers.png)
![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} committers screen. A text box with the number 5, with a minus and a plus button, are outlined in orange.](/assets/images/help/enterprises/ghas-add-committers.png)
1. Click **Update committers**.

## Canceling your {% data variables.product.prodname_GH_advanced_security %} subscription
Expand All @@ -44,5 +44,5 @@ Each license for {% data variables.product.prodname_GH_advanced_security %} spec
{% data reusables.enterprise-accounts.license-tab %}
1. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Manage**, then click **Cancel Subscription**.

![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Cancel Subscription" button is highlighted with an orange outline.](/assets/images/help/enterprises/ghas-cancel-subscription.png)
![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Cancel Subscription" button is outlined in orange.](/assets/images/help/enterprises/ghas-cancel-subscription.png)
1. To confirm your cancellation, click **I understand, cancel Advanced Security**.
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ You can download the {% data variables.product.prodname_advanced_security %} lic
{%- ifversion ghec %}
1. Under "{% data variables.product.prodname_GH_advanced_security %}," click the **Manage** dropdown and then click **Download report**.

![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Download Report" button is highlighted with an orange outline.](/assets/images/help/enterprises/ghas-download-report.png)
![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Download Report" button is outlined in orange.](/assets/images/help/enterprises/ghas-download-report.png)

{%- elsif ghes %}
1. Under "{% data variables.product.prodname_GH_advanced_security %}," click **{% octicon "download" aria-hidden="true" %} CSV report** in the header of the "Committers" table.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,6 @@ If you're an organization or enterprise owner, you can switch between settings f
{% data reusables.user-settings.access_settings %}
1. At the top of the page, to the right of your name, click **Switch settings context**.

![Screenshot of the "Public profile" settings page for The Octocat. Next to the text "Your personal profile," a link, labeled "Switch settings context," is outlined in orange.](/assets/images/help/settings/context-switcher-button.png)
![Screenshot of the "Public profile" settings for The Octocat. Next to "Your personal profile," a "Switch settings context" link is outlined in orange.](/assets/images/help/settings/context-switcher-button.png)
1. Start typing the name of the account you want to switch to, then click the name of the account.
1. In the left sidebar, click **{% octicon "credit-card" aria-hidden="true" %} Billing and plans**.
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ You can update your enterprise account's credit card or PayPal details, or you c
{% data reusables.enterprise-accounts.billing-tab %}
1. Under "Payment information", click **Switch to invoice**.

![Screenshot of the billing page for an enterprise account. In the "Payment information" section, a link, labeled "Switch to invoice", is outlined in dark orange.](/assets/images/help/billing/switch-to-invoice.png)
![Screenshot of the billing page for an enterprise account. In the "Payment information" section, a "Switch to invoice" link is outlined in orange.](/assets/images/help/billing/switch-to-invoice.png)
1. Complete the form, then click **Contact Sales**.

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ When you change your billing cycle's duration, your {% data variables.product.pr
{% data reusables.enterprise-accounts.billing-tab %}
1. Under "Payment information", click **Switch to yearly billing and save** or **Switch to monthly billing**.

![Screenshot of the billing page for an enterprise account. In the "Payment information" section, a link, labeled "Switch to yearly billing and save", is outlined in dark orange.](/assets/images/help/billing/switch-to-yearly-billing.png)
![Screenshot of the billing page for an enterprise account. In "Payment information", a "Switch to yearly billing and save" link is outlined in orange.](/assets/images/help/billing/switch-to-yearly-billing.png)
1. Under "How often do you want to be billed?", select a billing cycle.
1. Click **Change your account's billing cycle**.
{% endif %}
Loading

0 comments on commit 9a1c3b0

Please sign in to comment.