From f01f6165c1f06f6867c4beb6a5a4bce945c25fd1 Mon Sep 17 00:00:00 2001 From: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Date: Thu, 16 Jan 2025 15:33:31 +0000 Subject: [PATCH 01/12] Enterprise access restrictions [Limited GA] (#53750) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Vanessa Co-authored-by: Stacy Carter --- .../index.md | 1 + ...ss-to-githubcom-using-a-corporate-proxy.md | 203 ++++++++++++++++++ ...o-your-enterprise-with-an-ip-allow-list.md | 2 +- 3 files changed, 205 insertions(+), 1 deletion(-) create mode 100644 content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-access-to-githubcom-using-a-corporate-proxy.md diff --git a/content/admin/configuring-settings/hardening-security-for-your-enterprise/index.md b/content/admin/configuring-settings/hardening-security-for-your-enterprise/index.md index 118552790225..2735cecd11f5 100644 --- a/content/admin/configuring-settings/hardening-security-for-your-enterprise/index.md +++ b/content/admin/configuring-settings/hardening-security-for-your-enterprise/index.md @@ -16,6 +16,7 @@ children: - /configuring-ssh-connections-to-your-instance - /configuring-the-referrer-policy-for-your-enterprise - /restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list + - /restricting-access-to-githubcom-using-a-corporate-proxy redirect_from: - /admin/configuration/hardening-security-for-your-enterprise --- diff --git a/content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-access-to-githubcom-using-a-corporate-proxy.md b/content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-access-to-githubcom-using-a-corporate-proxy.md new file mode 100644 index 000000000000..ec3a828da97a --- /dev/null +++ b/content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-access-to-githubcom-using-a-corporate-proxy.md @@ -0,0 +1,203 @@ +--- +title: Restricting access to GitHub.com using a corporate proxy +intro: 'Configure your proxy to block people from accessing {% data variables.product.prodname_dotcom_the_website %} with personal accounts.' +shortTitle: 'Block personal accounts' +product: 'Enterprises with {% data variables.product.prodname_emus %} on {% data variables.product.prodname_dotcom_the_website %}' +versions: + ghec: '*' +--- + +If you use {% data variables.product.prodname_emus %}, you can block users on your network from authenticating to {% data variables.product.prodname_dotcom_the_website %} with accounts that are not members of your enterprise. This helps reduce the risk of your company's data being exposed to the public. + +To enforce this restriction, you will configure your network proxy or firewall to inject a header into your users' web and API requests to {% data variables.product.prodname_dotcom_the_website %}. + +This feature requires an external firewall or proxy. {% data variables.contact.github_support %} cannot assist with setup or troubleshooting for external tools such as these. For more about scope of support, see [AUTOTITLE](/support/learning-about-github-support/about-github-support#scope-of-support). + +## Requesting access + +This feature is not enabled by default, and is currently only available to enterprises that pay by invoice. + +* If you pay by invoice, to request access, contact your account manager in {% data variables.product.github %}'s Sales team. +* If you pay via credit card or PayPal, this feature is currently unavailable. + +## Prerequisites + +* You must use an {% data variables.enterprise.prodname_emu_enterprise %} on {% data variables.product.prodname_dotcom_the_website %}. + * You'll know you're using an {% data variables.enterprise.prodname_emu_enterprise %} if all your users' usernames are appended with your enterprise's shortcode. + * If you use {% data variables.enterprise.data_residency %}, your enterprise resides on a dedicated subdomain of {% data variables.enterprise.data_residency_site %}, so the header is not required to differentiate traffic to your enterprise's resources. +* To enforce the restriction, all traffic must flow through a proxy or firewall. The proxy or firewall must: + * Be capable of intercepting and editing traffic, commonly called a "break and inspect" proxy + * Support arbitrary header injection +* Your account team at {% data variables.product.company_short %} must have granted you access to this feature. + +## Finding the header + +To enforce the restriction, you will inject a header into all traffic going to certain supported endpoints. The header is in the following format. + +```text +sec-GitHub-allowed-enterprise: ENTERPRISE-ID +``` + +An enterprise owner can identify the correct enterprise ID to use in the header for your enterprise. + +{% data reusables.enterprise-accounts.access-enterprise-emu %} +{% data reusables.enterprise-accounts.settings-tab %} +1. Under {% octicon "gear" aria-hidden="true" %} **Settings**, click **Authentication security**. +1. In the "Enterprise access restrictions" section, find the header for your enterprise. This section is only visible for enterprises with the feature enabled. + +## Using the header + +For best results, configure your proxy to inject the header into all traffic to the following **supported endpoints**. + +| Endpoint | Purpose | +| -------- | ------- | +| `github.com/*` | Web traffic to {% data variables.product.prodname_dotcom_the_website %} | +| `api.github.com/*` | REST and GraphQL API requests | +| `*.githubcopilot.com` | Traffic required for certain {% data variables.product.prodname_copilot %} features | + +This will prevent people on your network from accessing these endpoints with user accounts that are not owned by your enterprise. Alongside this feature, you can block traffic from outside your network by setting up an IP allow list. See [AUTOTITLE](/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list). + +>[!NOTE] Access to `github.com/login` is required to create support tickets. To ensure users with support entitlements can request help, you may want to exempt these users from the restriction. + +### Lifting the restriction for certain users + +You may want to lift the restriction for certain users who need to contribute to open source resources using a personal account, or who may need to create support tickets in case of issues. To handle this, you must configure your network to inject the header only for users that you intend to restrict. + +Options include: + +* **Network segregation**: Create a "work" network that injects the header, and an "open source" network that does not. Limit access to the "open source" network to users who need it. +* **Device grouping**: If your proxy or firewall is authenticated, you can collect a group of users who don't need the header, and selectively exclude them from injection. + +## Unsupported features + +Because this restriction only applies to requests that are sent via a proxy that adds an enterprise header, certain {% data variables.product.github %} features do not support the restriction to block users from accessing or using their personal accounts. To block users on your network from accessing these features, you will need to make the changes described below. + +| Feature | Associated endpoint | Notes | +| ------- | ------------------- | ----- | +| {% data variables.product.prodname_pages %} | `github.io` | This is generally user-generated content that cannot accept data. You may not want to restrict access. | +| {% data variables.product.prodname_github_codespaces %} | `github.dev` | To restrict access, block the endpoint entirely. | +| SSH access | Port 22 on {% data variables.product.prodname_dotcom_the_website %} | To restrict access, block the endpoint entirely. | +| {% data variables.product.github %}-hosted runners | Various | To enforce specific routing, use Azure private networking. See [AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise). | + +### Endpoints that don't require restriction + +The following endpoints do not support or require the restriction because they only provide data, and do not accept it. + +* `*.githubusercontent.com` +* `*.githubassets.com` +* Websocket traffic on {% data variables.product.prodname_dotcom_the_website %} + +## How does the restriction work? + +For traffic that includes the enterprise header, when a user attempts to access {% data variables.product.prodname_dotcom_the_website %} via the web, Git, or API using a user account (or a token associated with a user account) that is not a member of the enterprise: + +* The user will see an error message with a `403` status code. See [Errors displayed to blocked users](#errors-displayed-to-blocked-users). +* A `business.proxy_security_header_unsatisfied` event will be logged in the enterprise audit logs. These log events will have no `actor` field due to privacy reasons, but will have an `actor_ip` field if enabled (see [AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise)). To investigate these events further, you can review the proxy logs in your environment. + +The following sections provide details for the expected behavior that applies to your users' web activity and API requests. + +### Web activity + +For activity in the {% data variables.product.prodname_dotcom_the_website %} user interface, the header restricts which accounts a user can sign in to. + +While on your network, a user: + +* **Can** sign in to a {% data variables.enterprise.prodname_managed_user %} in your enterprise. +* **Cannot** sign in to an account outside your enterprise. +* **Cannot** use the account switcher to switch to an account outside your enterprise. + +If a user is already signed in to an account outside your enterprise (for example, they signed in while outside your network), when the user brings their device into your network, they will receive an error and be unable to access {% data variables.product.prodname_dotcom_the_website %} until they sign in with their enterprise-owned account. + +### Git activity + +If your proxy is configured to inject the header into HTTP(S) requests, users on your network will be blocked from authenticating to {% data variables.product.prodname_dotcom_the_website %} over HTTP(S), unless they are a member of your enterprise. Public read requests are not blocked for unauthenticated anonymous users. + +You cannot use the enterprise header to restrict Git activity over SSH. Instead, you can choose to block the port for SSH requests entirely. See [Unsupported features](#unsupported-features). + +### API requests + +For REST and GraphQL API traffic to api.github.com, including requests via the {% data variables.product.prodname_cli %}, the header restricts the use of access tokens while users are connected to your network. + +| Scenario | Outcome | Affected token types | +| -------- | ------- | -------------------- | +| A user uses a {% data variables.product.pat_generic %} associated with an account owned by your enterprise. | The {% data variables.product.pat_generic %} works as expected in API requests. | `ghp_` and `github_pat_` | +| While connected to your network, a user tries to use a {% data variables.product.pat_generic %} associated with a user outside your enterprise. | Requests using the token are blocked. | `ghp_` and `github_pat_` | +| While outside your network, using an account outside your enterprise, a user signs in to an OAuth app that runs on their device. The user then brings their device inside your network. | OAuth tokens from the app stop working. | `gho_` | +| While outside your network, using an account outside your enterprise, a user signs in to a {% data variables.product.prodname_github_app %} that runs on their device. The user then brings their device inside your network. | Tokens from the app stop working. | `ghu_` | +| While connected to your network, an application attempts to refresh a session for a user outside your enterprise using a {% data variables.product.prodname_github_app %} refresh token. | The refresh fails. | `ghr_` | +| While connected to your network, an application attempts to get an installation token (a token without a user identity, just the app's identity) for an organization outside your enterprise. | The token will not work. | `ghs_` | + +## Errors displayed to blocked users + +Errors will be displayed to users when the restriction is working as intended. Errors occur in the following situations: + +* **Web activity**: When a user is blocked from signing in or using an existing stale session. +* **API activity**: When a user tries to use a token that is associated with a user outside the enterprise. +* **Installation token:** When an application attempts to use an installation token to access an organization or user account outside the enterprise. For installations, only write requests are blocked. Read requests are not blocked to resources outside of the enterprise. To learn more about installation tokens, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation). + +| Scenario | Error code | Message | +| -------- | ---------- | ------- | +| Web activity | 403 | Your network administrator has blocked access to {% data variables.product.github %} except for the `ENTERPRISE` Enterprise. Please sign in with your `_SHORTCODE` account to access {% data variables.product.github %}. | +| API activity | 403 | Your network administrator has blocked access to {% data variables.product.github %} except for the `ENTERPRISE` Enterprise. Please use a token for a user from the `_SHORTCODE` enterprise to access {% data variables.product.github %}. | +| Installation token | 403 | Your network administrator has blocked access to {% data variables.product.github %} except for the `ENTERPRISE` Enterprise. Only tokens for the "`SHORTCODE`" enterprise can access {% data variables.product.github %}. | + +Errors with a `400` code indicate an error in your configuration. See [Troubleshooting](#troubleshooting). + +## Example of testing locally + +You can test your network configuration locally using a web debugging tool. This section provides an example using [Fiddler](https://www.telerik.com/fiddler). Note that Fiddler and other external debugging tools are **not** in the scope of {% data variables.contact.github_support %}. + +In the following example, you will add some FiddlerScript to run on every request. + +1. Install [Fiddler](https://www.telerik.com/fiddler). +1. Configure Fiddler to decrypt HTTPS traffic. See the [Fiddler documentation](https://docs.telerik.com/fiddler/configure-fiddler/tasks/decrypthttps). +1. In Fiddler, navigate to the "FiddlerScript" tab, and add the following code to the `OnBeforeRequest` function. Set the `enterpriseId` variable to your own enterprise ID. + + ```javascript copy + // Your enterprise id + var enterpriseId: String = "YOUR-ID"; + + //Inject on the web UI + if (oSession.HostnameIs("github.com")){ + oSession.oRequest.headers.Add("sec-GitHub-allowed-enterprise",enterpriseId) + oSession["ui-color"] = "green"; + } + + // Inject on API calls + if (oSession.HostnameIs("api.github.com")){ + oSession.oRequest.headers.Add("sec-GitHub-allowed-enterprise",enterpriseId) + oSession["ui-color"] = "blue"; + } + + // Inject on Copilot API calls + if (oSession.HostnameIs("githubcopilot.com")){ + oSession.oRequest.headers.Add("sec-GitHub-allowed-enterprise",enterpriseId) + oSession["ui-color"] = "yellow"; + } + ``` + +1. Click **Save script**. + +The header will now be injected for each of the specified domains while packet capture is active. To enable or disable injection, you can toggle packet capture by clicking **File** > **Capture Traffic**. + +You can turn this injection on and off to simulate signing in with a disallowed account and then entering the network, or trying to sign in to a disallowed account while on the network. + +## Troubleshooting + +If your header injection isn't working as expected, you will see errors with a `400` code when you try to use affected endpoints. These are distinct from the `403` errors displayed when the feature is working as expected (see [Errors displayed to blocked users](#errors-displayed-to-blocked-users)). + +Generally, `400` errors occur in the following situations. + +* The header uses an invalid slug or enterprise ID. +* The header lists more than one enterprise. +* The request contains multiple `sec-GitHub-allowed-enterprise` headers. + +| Scenario | Error code | Message | +| -------- | ---------- | ------- | +| Invalid slug or ID | 400 | The enterprise named in the `sec-GitHub-allowed-enterprise` header cannot be found. Ensure that the "enterprise slug" is entered correctly in the firewall or proxy settings. Contact your network administrator if this error persists. | +| More than one enterprise | 400 | Only one enterprise can be used with the `sec-GitHub-allowed-enterprise` header. Ensure that only a single enterprise and header is provided. If this issue persists, contact your network administrator | +| Multiple headers | 400 | More than one `sec-GitHub-allowed-enterprise` was received. This header must be overwritten by the firewall or proxy, to ensure that only a single enterprise is granted access. If this issue persists, contact your network administrator. | + +## Further reading + +* [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network#configuring-copilot-subscription-based-network-routing-for-your-organization) diff --git a/content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md b/content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md index 6fed2f537952..a82092cf9570 100644 --- a/content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md +++ b/content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md @@ -1,6 +1,6 @@ --- title: Restricting network traffic to your enterprise with an IP allow list -shortTitle: Restricting network traffic +shortTitle: IP allow list intro: You can restrict access to your enterprise and only allow access to your resources from specified IP addresses by using an IP allow list. permissions: Enterprise owners can configure IP allow lists. versions: From f8f4d9fc27450c1f3dad4243874fc35f752367fa Mon Sep 17 00:00:00 2001 From: Larissa Fortuna <56982181+lkfortuna@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:15:50 -0800 Subject: [PATCH 02/12] Arm-runners-for-oss release PR (#53632) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> --- .../about-github-hosted-runners.md | 22 ++++++++++++------ .../actions/supported-github-runners.md | 23 +++++++++++++++++++ 2 files changed, 38 insertions(+), 7 deletions(-) diff --git a/content/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners.md b/content/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners.md index f52b3d338f56..6e767be88068 100644 --- a/content/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners.md @@ -27,7 +27,7 @@ Runners are the machines that execute jobs in a {% data variables.product.prodna {% ifversion not ghes %} -You can choose one of the standard {% data variables.product.prodname_dotcom %}-hosted runner options or, if you are on the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plan, you can provision a runner with more cores, or a runner that's powered by a GPU or ARM processor. These machines are referred to as "{% data variables.actions.hosted_runner %}." For more information, see [AUTOTITLE](/enterprise-cloud@latest/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners). +You can choose one of the standard {% data variables.product.prodname_dotcom %}-hosted runner options or, if you are on the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plan, you can provision a runner with more cores, or a runner that's powered by a GPU processor. These machines are referred to as "{% data variables.actions.hosted_runner %}." For more information, see [AUTOTITLE](/enterprise-cloud@latest/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners). Using {% data variables.product.prodname_dotcom %}-hosted runners requires network access with at least 70 kilobits per second upload and download speeds. @@ -118,7 +118,11 @@ While the job runs, the logs and output can be viewed in the {% data variables.p {% ifversion actions-hosted-runners %} -{% data variables.product.prodname_dotcom %}-hosted runners are available for use in both public and private repositories. +Ranges of {% data variables.product.prodname_dotcom %}-hosted runners are available for use in public and private repositories. + +For lists of available runners, see: +* [Standard runners for **public** repositories](#standard-github-hosted-runners-for-public-repositories) +* {% ifversion ghec %}[Standard runners for **private** and **internal** repositories](#standard-github-hosted-runners-for-internal-and-private-repositories){% else %}[Standard runners for **private** repositories](#standard-github-hosted-runners-for--private-repositories){% endif %} {% data variables.product.prodname_dotcom %}-hosted Linux runners support hardware acceleration for Android SDK tools, which makes running Android tests much faster and consumes fewer minutes. For more information on Android hardware acceleration, see [Configure hardware acceleration for the Android Emulator](https://developer.android.com/studio/run/emulator-acceleration) in the Android Developers documentation. @@ -144,15 +148,17 @@ Workflow logs list the runner used to run a job. For more information, see [AUTO For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners). -## Supported software +## Runner Images + +{% data variables.product.github %} maintains our own set of VM images for our standard hosted runners. This includes the images for macOS, x64 linux and Windows images. The list of images and their included tools are managed in the [`actions/runner-images`](https://github.com/actions/runner-images) repository. Our arm64 linux images are partner images, and those are managed in the [`actions/partner-runner-images`](https://github.com/actions/partner-runner-images) repository. -The software tools included in {% data variables.product.prodname_dotcom %}-hosted runners are updated weekly. The update process takes several days, and the list of preinstalled software on the `main` branch is updated after the whole deployment ends. +### Preinstalled software for GitHub-owned images -### Preinstalled software +The software tools included in our GitHub-owned images are updated weekly. The update process takes several days, and the list of preinstalled software on the `main` branch is updated after the whole deployment ends. Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Runner Image` section. The link following `Included Software` will describe the preinstalled tools on the runner that ran the workflow. -For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history). For the overall list of included tools for each runner operating system, see the [Available Images](https://github.com/actions/runner-images#available-images) documentation the runner images repository. +For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history). {% data variables.product.prodname_dotcom %}-hosted runners include the operating system's default built-in tools, in addition to the packages listed in the above references. For example, Ubuntu and macOS runners include `grep`, `find`, and `which`, among other default tools. @@ -178,7 +184,9 @@ You can install additional software on {% data variables.product.prodname_dotcom {% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. {% data variables.product.prodname_dotcom %} hosts macOS runners in Azure data centers. -For Linux and Windows runners, {% data variables.product.company_short %} uses `Dadsv5-series` virtual machines. For more information, see [Dasv5 and Dadsv5-series](https://learn.microsoft.com/en-us/azure/virtual-machines/dasv5-dadsv5-series#dadsv5-series) in the Microsoft Azure documentation. +For Linux and Windows x64 runners, {% data variables.product.company_short %} uses `Dadsv5-series` virtual machines. For more information, see [Dasv5 and Dadsv5-series](https://learn.microsoft.com/en-us/azure/virtual-machines/dasv5-dadsv5-series#dadsv5-series) in the Microsoft Azure documentation. + +For linux arm64 runners, {% data variables.product.company_short %} uses `Dpdsv6-series` virtual machines. For more information, see [Dpdsv6 series](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/general-purpose/dpdsv6-series?tabs=sizebasic) in the Microsoft Azure documentation. GPU runners use `NCasT4_v3-series` virtual machines. For more information, see [NCasT4_v3-series](https://learn.microsoft.com/en-us/azure/virtual-machines/nct4-v3-series) in the Microsoft Azure documentation. diff --git a/data/reusables/actions/supported-github-runners.md b/data/reusables/actions/supported-github-runners.md index 0cf6d12a0c77..1a4e57921507 100644 --- a/data/reusables/actions/supported-github-runners.md +++ b/data/reusables/actions/supported-github-runners.md @@ -9,6 +9,7 @@ For public repositories, jobs using the workflow labels shown in the table below Processor (CPU) Memory (RAM) Storage (SSD) + Architecture Workflow label @@ -18,6 +19,7 @@ For public repositories, jobs using the workflow labels shown in the table below 4 16 GB 14 GB + x64 ubuntu-latest, ubuntu-24.04, @@ -30,6 +32,7 @@ For public repositories, jobs using the workflow labels shown in the table below 4 16 GB 14 GB + x64 windows-latest, windows-2025[{% data variables.release-phases.public_preview_caps %}], @@ -37,11 +40,23 @@ For public repositories, jobs using the workflow labels shown in the table below windows-2019 + + Linux [Public preview] + 4 + 16 GB + 14 GB + arm64 + + ubuntu-24.04-arm, + ubuntu-22.04-arm + + macOS 4 14 GB 14 GB + Intel macos-13 @@ -51,6 +66,7 @@ For public repositories, jobs using the workflow labels shown in the table below 3 (M1) 7 GB 14 GB + arm64 macos-latest, macos-14, @@ -61,6 +77,8 @@ For public repositories, jobs using the workflow labels shown in the table below +>[!NOTE] The arm64 Linux runner is in {% data variables.release-phases.public_preview %} and subject to change. + ### Standard {% data variables.product.prodname_dotcom %}-hosted runners for {% ifversion ghec %}internal and{% endif %} private repositories For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using the workflow labels shown in the table below will run on virtual machines with the associated specifications. These runners use your {% data variables.product.prodname_dotcom %} account's allotment of free minutes, and are then charged at the per minute rates. For more information, see [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates). @@ -72,6 +90,7 @@ For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using Processor (CPU) Memory (RAM) Storage (SSD) + Architecture Workflow label @@ -81,6 +100,7 @@ For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using 2 7 GB 14 GB + x64 ubuntu-latest, ubuntu-24.04, @@ -93,6 +113,7 @@ For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using 2 7 GB 14 GB + x64 windows-latest, windows-2025[{% data variables.release-phases.public_preview_caps %}], @@ -105,6 +126,7 @@ For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using 4 14 GB 14 GB + Intel macos-13 @@ -114,6 +136,7 @@ For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using 3 (M1) 7 GB 14 GB + arm64 macos-latest, macos-14, From 287d98abae61533094f4df060bdff171a9d10116 Mon Sep 17 00:00:00 2001 From: Anne-Marie <102995847+am-stead@users.noreply.github.com> Date: Thu, 16 Jan 2025 16:19:13 +0000 Subject: [PATCH 03/12] Hack Week 2025: update `product.product_name` in `/get-started` (i) (#53929) --- .../contributing-to-a-project.md | 14 ++++---- .../following-organizations.md | 12 +++---- .../following-people.md | 16 ++++----- .../exploring-projects-on-github/index.md | 2 +- .../saving-repositories-with-stars.md | 2 +- .../about-github-advanced-security.md | 2 +- .../access-permissions-on-github.md | 6 ++-- .../learning-about-github/githubs-plans.md | 2 +- .../types-of-github-accounts.md | 8 ++--- .../about-github-and-git.md | 34 +++++++++---------- .../downloading-files-from-github.md | 14 ++++---- .../finding-inspiration-on-github.md | 16 ++++----- .../git-and-github-learning-resources.md | 12 +++---- .../start-your-journey/hello-world.md | 30 ++++++++-------- .../get-started/start-your-journey/index.md | 2 +- .../setting-up-your-profile.md | 16 ++++----- .../uploading-a-project-to-github.md | 16 ++++----- .../about-versions-of-github-docs.md | 2 +- .../about-writing-and-formatting-on-github.md | 4 +-- .../basic-writing-and-formatting-syntax.md | 16 ++++----- 20 files changed, 113 insertions(+), 113 deletions(-) diff --git a/content/get-started/exploring-projects-on-github/contributing-to-a-project.md b/content/get-started/exploring-projects-on-github/contributing-to-a-project.md index 1d532847ff15..57c432826304 100644 --- a/content/get-started/exploring-projects-on-github/contributing-to-a-project.md +++ b/content/get-started/exploring-projects-on-github/contributing-to-a-project.md @@ -46,17 +46,17 @@ This tutorial uses [the Spoon-Knife project](https://github.com/octocat/Spoon-Kn ## Cloning a fork to your computer -You've successfully forked the Spoon-Knife repository, but so far, it only exists on {% data variables.product.product_name %}. To be able to work on the project, you will need to clone it to your computer. +You've successfully forked the Spoon-Knife repository, but so far, it only exists on {% data variables.product.github %}. To be able to work on the project, you will need to clone it to your computer. You can clone your fork with the command line, {% data variables.product.prodname_cli %}, or {% data variables.product.prodname_desktop %}. {% webui %} -1. On {% data variables.product.product_name %}, navigate to **your fork** of the Spoon-Knife repository. +1. On {% data variables.product.github %}, navigate to **your fork** of the Spoon-Knife repository. {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.change-current-directory-clone %} -1. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`: +1. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.github %} username instead of `YOUR-USERNAME`: ```shell git clone https://{% data variables.product.product_url %}/YOUR-USERNAME/Spoon-Knife @@ -157,7 +157,7 @@ For more information about how to stage and commit changes in {% data variables. When you stage and commit files, you essentially tell Git, "Okay, take a snapshot of my changes!" You can continue to make more changes, and take more commit snapshots. -Right now, your changes only exist locally. When you're ready to push your changes up to {% data variables.product.product_name %}, push your changes to the remote. +Right now, your changes only exist locally. When you're ready to push your changes up to {% data variables.product.github %}, push your changes to the remote. {% webui %} @@ -185,11 +185,11 @@ For more information about how to push changes in {% data variables.product.prod At last, you're ready to propose changes into the main project! This is the final step in producing a fork of someone else's project, and arguably the most important. If you've made a change that you feel would benefit the community as a whole, you should definitely consider contributing back. -To do so, head on over to the repository on {% data variables.product.product_name %} where your project lives. For this example, it would be at `https://github.com//Spoon-Knife`. You'll see a banner indicating that your branch is one commit ahead of `octocat:main`. Click **Contribute** and then **Open a pull request**. +To do so, head on over to the repository on {% data variables.product.github %} where your project lives. For this example, it would be at `https://github.com//Spoon-Knife`. You'll see a banner indicating that your branch is one commit ahead of `octocat:main`. Click **Contribute** and then **Open a pull request**. -{% data variables.product.product_name %} will bring you to a page that shows the differences between your fork and the `octocat/Spoon-Knife` repository. Click **Create pull request**. +{% data variables.product.github %} will bring you to a page that shows the differences between your fork and the `octocat/Spoon-Knife` repository. Click **Create pull request**. -{% data variables.product.product_name %} will bring you to a page where you can enter a title and a description of your changes. It's important to provide as much useful information and a rationale for why you're making this pull request in the first place. The project owner needs to be able to determine whether your change is as useful to everyone as you think it is. Finally, click **Create pull request**. +{% data variables.product.github %} will bring you to a page where you can enter a title and a description of your changes. It's important to provide as much useful information and a rationale for why you're making this pull request in the first place. The project owner needs to be able to determine whether your change is as useful to everyone as you think it is. Finally, click **Create pull request**. ## Managing feedback diff --git a/content/get-started/exploring-projects-on-github/following-organizations.md b/content/get-started/exploring-projects-on-github/following-organizations.md index 3a3eae12b577..0c02e353516b 100644 --- a/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/content/get-started/exploring-projects-on-github/following-organizations.md @@ -1,6 +1,6 @@ --- title: Following organizations -intro: 'You can follow organizations on {% data variables.product.product_name %} to receive notifications about their activity.' +intro: 'You can follow organizations on {% data variables.product.github %} to receive notifications about their activity.' versions: feature: for-you-feed topics: @@ -9,23 +9,23 @@ topics: {% data reusables.organizations.follow-organizations-beta %} -## About followers on {% data variables.product.product_name %} +## About followers {% data reusables.organizations.about-following-organizations %} For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community). -You can unfollow an organization if you do not wish to see their {% ifversion fpt or ghec %}public{% endif %} activity on {% data variables.product.product_name %}. +You can unfollow an organization if you do not wish to see their {% ifversion fpt or ghec %}public{% endif %} activity on {% data variables.product.github %}. -## Following an organization on {% data variables.product.product_name %} +## Following an organization 1. Go to the organization page you want to follow. 1. In the top-right corner, click **Follow**. -## Unfollowing an organization on {% data variables.product.product_name %} +## Unfollowing an organization 1. Go to the organization page you want to unfollow. 1. In the top-right corner, click **Unfollow**. -## Viewing people and organizations a user follows on {% data variables.product.product_name %} +## Viewing people and organizations a user follows {% data reusables.profile.navigate-to-user-profile %} 1. Under the user's profile picture, click **following**. diff --git a/content/get-started/exploring-projects-on-github/following-people.md b/content/get-started/exploring-projects-on-github/following-people.md index fa2c4484be8e..d2dfc870d151 100644 --- a/content/get-started/exploring-projects-on-github/following-people.md +++ b/content/get-started/exploring-projects-on-github/following-people.md @@ -1,6 +1,6 @@ --- title: Following people -intro: 'You can follow people on {% data variables.product.product_name %} to receive notifications about their activity{% ifversion fpt or ghec %} and discover projects in their communities{% endif %}.' +intro: 'You can follow people on {% data variables.product.github %} to receive notifications about their activity{% ifversion fpt or ghec %} and discover projects in their communities{% endif %}.' permissions: '{% data reusables.enterprise-accounts.emu-permission-follow %}' redirect_from: - /articles/following-people @@ -14,30 +14,30 @@ topics: - Profile --- -## About followers on {% data variables.product.product_name %} +## About followers -When you follow people, you'll see their public activity on your personal dashboard.{% ifversion fpt or ghec %} If someone you follow stars a public repository, {% data variables.product.product_name %} may recommend the repository to you.{% endif %} For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community). +When you follow people, you'll see their public activity on your personal dashboard.{% ifversion fpt or ghec %} If someone you follow stars a public repository, {% data variables.product.github %} may recommend the repository to you.{% endif %} For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community). -You can unfollow someone if you do not wish to see their public activity on {% data variables.product.product_name %}. +You can unfollow someone if you do not wish to see their public activity on {% data variables.product.github %}. -## Following a user on {% data variables.product.product_name %} +## Following a user {% data reusables.profile.navigate-to-user-profile %} 1. Under the user's profile picture, click **Follow**. -## Unfollowing a user on {% data variables.product.product_name %} +## Unfollowing a user {% data reusables.profile.navigate-to-user-profile %} 1. Under the user's profile picture, click **Unfollow**. -## Viewing followed users on {% data variables.product.product_name %} +## Viewing followed users {% data reusables.profile.navigate-to-user-profile %} 1. Under the user's profile picture, click **following**. ![Screenshot of the sidebar of @octocat's profile page. A link, labeled "9 following", is outlined in dark orange.](/assets/images/help/profile/user-profile-following.png) -## Viewing followers on {% data variables.product.product_name %} +## Viewing followers {% data reusables.profile.navigate-to-user-profile %} 1. Under the user's profile picture, click **followers**. diff --git a/content/get-started/exploring-projects-on-github/index.md b/content/get-started/exploring-projects-on-github/index.md index 4589eb3fd40a..0d37c5176c6a 100644 --- a/content/get-started/exploring-projects-on-github/index.md +++ b/content/get-started/exploring-projects-on-github/index.md @@ -1,6 +1,6 @@ --- title: Exploring projects on GitHub -intro: 'Discover interesting projects on {% data variables.product.product_name %} and contribute to open source by collaborating with other people.' +intro: 'Discover interesting projects on {% data variables.product.github %} and contribute to open source by collaborating with other people.' redirect_from: - /categories/stars - /categories/87/articles diff --git a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md index 492f4b8a4139..5af2eb3f2b9e 100644 --- a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md +++ b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md @@ -24,7 +24,7 @@ You can search, sort, and filter your starred repositories and topics on your {% Starring makes it easy to find a repository or topic again later. You can see all the repositories and topics you have starred by going to your {% data variables.explore.your_stars_page %}. {% ifversion fpt or ghec %} -You can star repositories and topics to discover similar projects on {% data variables.product.product_name %}. When you star repositories or topics, {% data variables.product.product_name %} may recommend related content on your personal dashboard. For more information, see [AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) and [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community). +You can star repositories and topics to discover similar projects on {% data variables.product.github %}. When you star repositories or topics, {% data variables.product.github %} may recommend related content on your personal dashboard. For more information, see [AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) and [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community). {% endif %} Starring a repository also shows appreciation to the repository maintainer for their work. Many of {% data variables.product.prodname_dotcom %}'s repository rankings depend on the number of stars a repository has. In addition, [Explore {% data variables.product.prodname_dotcom %}](https://github.com/explore) shows popular repositories based on the number of stars they have. diff --git a/content/get-started/learning-about-github/about-github-advanced-security.md b/content/get-started/learning-about-github/about-github-advanced-security.md index 7e6ae266f646..e52720c4620f 100644 --- a/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/content/get-started/learning-about-github/about-github-advanced-security.md @@ -31,7 +31,7 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th * **{% data variables.product.prodname_code_scanning_caps %}** - Search for potential security vulnerabilities and coding errors in your code using {% data variables.product.prodname_codeql %} or a third-party tool. See [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning) and [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql). -* **{% data variables.product.prodname_codeql_cli %}** - Run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.product_name %}. See [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli). +* **{% data variables.product.prodname_codeql_cli %}** - Run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.github %}. See [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli). * **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into {% ifversion fpt %}private repositories{% else %} the repository{% endif %}. If push protection is enabled, {% data variables.product.prodname_dotcom %} also detects secrets when they are pushed to your repository. {% ifversion secret-scanning-enable-by-default-for-public-repos %}{% data variables.secret-scanning.user_alerts_caps %} and push protection are available and free of charge for all {% ifversion ghec %}user-owned {% endif %}public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} See [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning) and [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection). diff --git a/content/get-started/learning-about-github/access-permissions-on-github.md b/content/get-started/learning-about-github/access-permissions-on-github.md index 589b7b217ebe..5744c802943e 100644 --- a/content/get-started/learning-about-github/access-permissions-on-github.md +++ b/content/get-started/learning-about-github/access-permissions-on-github.md @@ -7,7 +7,7 @@ redirect_from: - /articles/access-permissions-on-github - /github/getting-started-with-github/access-permissions-on-github - /github/getting-started-with-github/learning-about-github/access-permissions-on-github -intro: 'With roles, you can control who has access to your accounts and resources on {% data variables.product.product_name %} and the level of access each person has.' +intro: 'With roles, you can control who has access to your accounts and resources and the level of access each person has.' versions: fpt: '*' ghes: '*' @@ -18,7 +18,7 @@ topics: shortTitle: Access permissions --- -## About access permissions on {% data variables.product.prodname_dotcom %} +## About access permissions on {% data variables.product.github %} {% data reusables.organizations.about-roles %} @@ -46,7 +46,7 @@ For more information about permissions for enterprise accounts, see [the {% data _Enterprise owners_ have ultimate power over the enterprise account and can take every action in the enterprise account.{% ifversion ghec or ghes %} _Billing managers_ can manage your enterprise account's billing settings.{% endif %} Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise). {% ifversion ghec %} -If an enterprise uses {% data variables.product.prodname_emus %}, members are provisioned as new personal accounts on {% data variables.product.prodname_dotcom %} and are fully managed by the identity provider. The {% data variables.enterprise.prodname_managed_users %} have read-only access to repositories that are not a part of their enterprise and cannot interact with users that are not also members of the enterprise. Within the organizations owned by the enterprise, the {% data variables.enterprise.prodname_managed_users %} can be granted the same granular access levels available for regular organizations. For more information, see [AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users). +If an enterprise uses {% data variables.product.prodname_emus %}, members are provisioned as new personal accounts on {% data variables.product.github %} and are fully managed by the identity provider. The {% data variables.enterprise.prodname_managed_users %} have read-only access to repositories that are not a part of their enterprise and cannot interact with users that are not also members of the enterprise. Within the organizations owned by the enterprise, the {% data variables.enterprise.prodname_managed_users %} can be granted the same granular access levels available for regular organizations. For more information, see [AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users). {% endif %} {% endif %} diff --git a/content/get-started/learning-about-github/githubs-plans.md b/content/get-started/learning-about-github/githubs-plans.md index eeac97912f29..ac5a4558f56d 100644 --- a/content/get-started/learning-about-github/githubs-plans.md +++ b/content/get-started/learning-about-github/githubs-plans.md @@ -138,7 +138,7 @@ In addition to the features available with {% data variables.product.prodname_te For a detailed list of the features available with {% data variables.product.prodname_enterprise %}, see our [Pricing](https://github.com/pricing) page. -To see how {% data variables.product.product_name %} compares to GitLab, Bitbucket, and Jenkins, see [Comparing GitHub to other DevOps solutions](https://resources.github.com/devops/tools/compare/). +To see how {% data variables.product.github %} compares to GitLab, Bitbucket, and Jenkins, see [Comparing GitHub to other DevOps solutions](https://resources.github.com/devops/tools/compare/). You can set up trials to evaluate {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) and [AUTOTITLE](/enterprise-server@latest/admin/overview/setting-up-a-trial-of-github-enterprise-server). diff --git a/content/get-started/learning-about-github/types-of-github-accounts.md b/content/get-started/learning-about-github/types-of-github-accounts.md index ee2f4a6fe615..7e817ae8faa4 100644 --- a/content/get-started/learning-about-github/types-of-github-accounts.md +++ b/content/get-started/learning-about-github/types-of-github-accounts.md @@ -1,6 +1,6 @@ --- title: Types of GitHub accounts -intro: 'Accounts on {% data variables.product.product_name %} allow you to organize and control access to code.' +intro: 'Accounts on {% data variables.product.github %} allow you to organize and control access to code.' redirect_from: - /manage-multiple-clients - /managing-clients @@ -21,14 +21,14 @@ topics: - Security --- -## About accounts on {% data variables.product.product_name %} +## About accounts -With {% data variables.product.product_name %}, you can store and collaborate on code. Accounts allow you to organize and control access to that code. There are three types of accounts on {% data variables.product.product_name %}. +With {% data variables.product.github %}, you can store and collaborate on code. Accounts allow you to organize and control access to that code. There are three types of accounts on {% data variables.product.github %}. * User accounts * Organization accounts * Enterprise accounts -Every person who uses {% data variables.product.product_name %} signs in to a user account. An organization account enhances collaboration between multiple users, and {% ifversion fpt or ghec %}an enterprise account{% else %}the enterprise account for {% data variables.location.product_location %}{% endif %} allows central management of multiple organizations. +Every person who uses {% data variables.product.github %} signs in to a user account. An organization account enhances collaboration between multiple users, and {% ifversion fpt or ghec %}an enterprise account{% else %}the enterprise account for {% data variables.location.product_location %}{% endif %} allows central management of multiple organizations. ## User accounts diff --git a/content/get-started/start-your-journey/about-github-and-git.md b/content/get-started/start-your-journey/about-github-and-git.md index b8634f716ac9..2c3082c5f350 100644 --- a/content/get-started/start-your-journey/about-github-and-git.md +++ b/content/get-started/start-your-journey/about-github-and-git.md @@ -1,7 +1,7 @@ --- title: About GitHub and Git shortTitle: About GitHub and Git -intro: 'You can use {% data variables.product.product_name %} and Git to collaborate on work.' +intro: 'You can use {% data variables.product.github %} and Git to collaborate on work.' versions: fpt: '*' ghes: '*' @@ -17,17 +17,17 @@ redirect_from: - /get-started/quickstart/about-github-and-git --- -## About {% data variables.product.prodname_dotcom %} +## About {% data variables.product.github %} -{% data variables.product.prodname_dotcom %} is a {% ifversion not ghes %}cloud-based {% endif %}platform where you can store, share, and work together with others to write code. +{% data variables.product.github %} is a {% ifversion not ghes %}cloud-based {% endif %}platform where you can store, share, and work together with others to write code. -Storing your code in a "repository" on {% data variables.product.prodname_dotcom %} allows you to: +Storing your code in a "repository" on {% data variables.product.github %} allows you to: * **Showcase or share** your work. * **Track and manage** changes to your code over time. * Let others **review** your code, and make suggestions to improve it. * **Collaborate** on a shared project, without worrying that your changes will impact the work of your collaborators before you're ready to integrate them. -Collaborative working, one of {% data variables.product.prodname_dotcom %}’s fundamental features, is made possible by the open-source software, Git, upon which {% data variables.product.prodname_dotcom %} is built. +Collaborative working, one of {% data variables.product.github %}’s fundamental features, is made possible by the open-source software, Git, upon which {% data variables.product.github %} is built. ## About Git @@ -41,31 +41,31 @@ Typically, to do this in a Git-based workflow, you would: If you want to learn more about Git, see [AUTOTITLE](/get-started/using-git/about-git). -### How do Git and {% data variables.product.prodname_dotcom %} work together? +### How do Git and {% data variables.product.github %} work together? -When you upload files to {% data variables.product.prodname_dotcom %}, you'll store them in a "Git repository." This means that when you make changes (or "commits") to your files in {% data variables.product.prodname_dotcom %}, Git will automatically start to track and manage your changes. +When you upload files to {% data variables.product.github %}, you'll store them in a "Git repository." This means that when you make changes (or "commits") to your files in {% data variables.product.github %}, Git will automatically start to track and manage your changes. -There are plenty of Git-related actions that you can complete on {% data variables.product.prodname_dotcom %} directly in your browser, such as creating a Git repository, creating branches, and uploading and editing files. +There are plenty of Git-related actions that you can complete on {% data variables.product.github %} directly in your browser, such as creating a Git repository, creating branches, and uploading and editing files. -However, most people work on their files locally (on their own computer), then continually sync these local changes—and all the related Git data—with the central "remote" repository on {% data variables.product.prodname_dotcom %}. There are plenty of tools that you can use to do this, such as GitHub Desktop. +However, most people work on their files locally (on their own computer), then continually sync these local changes—and all the related Git data—with the central "remote" repository on {% data variables.product.github %}. There are plenty of tools that you can use to do this, such as GitHub Desktop. Once you start to collaborate with others and all need to work on the same repository at the same time, you’ll continually: -* **Pull** all the latest changes made by your collaborators from the remote repository on {% data variables.product.prodname_dotcom %}. -* **Push** back your own changes to the same remote repository on {% data variables.product.prodname_dotcom %}. +* **Pull** all the latest changes made by your collaborators from the remote repository on {% data variables.product.github %}. +* **Push** back your own changes to the same remote repository on {% data variables.product.github %}. -Git figures out how to intelligently merge this flow of changes, and {% data variables.product.prodname_dotcom %} helps you manage the flow through features such as "pull requests." +Git figures out how to intelligently merge this flow of changes, and {% data variables.product.github %} helps you manage the flow through features such as "pull requests." ## Where do I start? -If you're new to {% data variables.product.prodname_dotcom %}, and unfamiliar with Git, we recommend working through the articles in the [AUTOTITLE](/get-started/start-your-journey) category. The articles focus on tasks you can complete directly in your browser on {% data variables.product.prodname_dotcom %} and will help you to: +If you're new to {% data variables.product.github %}, and unfamiliar with Git, we recommend working through the articles in the [AUTOTITLE](/get-started/start-your-journey) category. The articles focus on tasks you can complete directly in your browser on {% data variables.product.github %} and will help you to: -* **Create an account** on {% data variables.product.prodname_dotcom %}. -* **Learn the "{% data variables.product.prodname_dotcom %} Flow"**, and the key principles of collaborative working (branches, commits, pull requests, merges). +* **Create an account** on {% data variables.product.github %}. +* **Learn the "{% data variables.product.github %} Flow"**, and the key principles of collaborative working (branches, commits, pull requests, merges). * **Personalise your profile** to share your interests and skills. -* **Explore {% data variables.product.prodname_dotcom %}** to find inspiration for your own projects and connect with others. +* **Explore {% data variables.product.github %}** to find inspiration for your own projects and connect with others. * Learn how to **download** interesting code for your own use. -* Learn how to **upload** something you're working on to a {% data variables.product.prodname_dotcom %} repository. +* Learn how to **upload** something you're working on to a {% data variables.product.github %} repository. {% ifversion fpt or ghec %} diff --git a/content/get-started/start-your-journey/downloading-files-from-github.md b/content/get-started/start-your-journey/downloading-files-from-github.md index 72e3e61d8621..ba778511e25a 100644 --- a/content/get-started/start-your-journey/downloading-files-from-github.md +++ b/content/get-started/start-your-journey/downloading-files-from-github.md @@ -1,7 +1,7 @@ --- title: Downloading files from GitHub shortTitle: Download files -intro: 'Learn how to download files from {% data variables.product.prodname_dotcom %}, and understand the difference between downloading, cloning, and forking.' +intro: 'Learn how to download files from {% data variables.product.github %}, and understand the difference between downloading, cloning, and forking.' versions: fpt: '*' ghec: '*' @@ -21,22 +21,22 @@ redirect_from: {% endif %} -There are different ways to get a copy of a repository's files on {% data variables.product.product_name %}. You can: +There are different ways to get a copy of a repository's files on {% data variables.product.github %}. You can: * **Download** a snapshot of a repository's files as a zip file to your own (local) computer. * **Clone** a repository to your local computer using Git. -* **Fork** a repository to create a new repository on {% data variables.product.prodname_dotcom %}. +* **Fork** a repository to create a new repository on {% data variables.product.github %}. Each of these methods has its own use case, which we'll explain in the next section. -This tutorial focuses on downloading a repository's files to your local computer. For example, if you've found some interesting content in a repository on {% data variables.product.product_name %}, downloading is a simple way to get a copy of the content, without using Git or applying version control. +This tutorial focuses on downloading a repository's files to your local computer. For example, if you've found some interesting content in a repository on {% data variables.product.github %}, downloading is a simple way to get a copy of the content, without using Git or applying version control. ### Understanding the differences between downloading, cloning, and forking | Term | Definition | Use case | | ------------- | ------------- | -------| | Download | To save a snapshot of a repository's files to your local computer. | You want to use or customize the content of the files, but you're not interested in applying version control. | -| Clone | To make a full copy of a repository's data, including all versions of every file and folder. | You want to work on a full copy of the repository on your local computer, using Git to track and manage your changes. You likely intend to sync these locally-made changes with the {% data variables.product.product_name %}-hosted repository. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository). | -| Fork | To create a new repository on {% data variables.product.product_name %}, linked to your personal account, that shares code and visibility settings with the original ("upstream") repository. | You want to use the original repository's data as a basis for your own project on {% data variables.product.prodname_dotcom %}. Or, you want to use the fork to propose changes to the original ("upstream") repository. After forking the repository, you still might want to clone the repository, so that you can work on the changes on your local computer. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). | +| Clone | To make a full copy of a repository's data, including all versions of every file and folder. | You want to work on a full copy of the repository on your local computer, using Git to track and manage your changes. You likely intend to sync these locally-made changes with the {% data variables.product.github %}-hosted repository. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository). | +| Fork | To create a new repository on {% data variables.product.github %}, linked to your personal account, that shares code and visibility settings with the original ("upstream") repository. | You want to use the original repository's data as a basis for your own project on {% data variables.product.prodname_dotcom %}. Or, you want to use the fork to propose changes to the original ("upstream") repository. After forking the repository, you still might want to clone the repository, so that you can work on the changes on your local computer. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). | ## Prerequisites @@ -56,7 +56,7 @@ You now have a copy of the repository's files saved as a zip file on your local ## Next steps -* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/uploading-a-project-to-github), you'll learn how to upload your own files to a remote repository on {% data variables.product.product_name %}. +* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/uploading-a-project-to-github), you'll learn how to upload your own files to a remote repository on {% data variables.product.github %}. ## Further reading diff --git a/content/get-started/start-your-journey/finding-inspiration-on-github.md b/content/get-started/start-your-journey/finding-inspiration-on-github.md index a35128c83033..c09d26b5f8de 100644 --- a/content/get-started/start-your-journey/finding-inspiration-on-github.md +++ b/content/get-started/start-your-journey/finding-inspiration-on-github.md @@ -8,7 +8,7 @@ redirect_from: - /github/getting-started-with-github/quickstart/be-social - /get-started/quickstart/be-social - /get-started/quickstart/finding-inspiration-on-github -intro: 'You can find inspiration for your own projects and learning on {% data variables.product.prodname_dotcom %} and connect with a community.' +intro: 'You can find inspiration for your own projects and learning on {% data variables.product.github %} and connect with a community.' permissions: '{% data reusables.enterprise-accounts.emu-permission-interact %}' versions: fpt: '*' @@ -22,7 +22,7 @@ topics: ## Introduction -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} is a vast open-source community. {% endif %}You can explore {% data variables.product.product_name %} to find interesting repositories, topics, code, people, and organizations that can inspire your own work, or support your own learning. +{% ifversion fpt or ghec %}{% data variables.product.github %} is a vast open-source community. {% endif %}You can explore {% data variables.product.github %} to find interesting repositories, topics, code, people, and organizations that can inspire your own work, or support your own learning. Once you've found something that interests you, you can: * **Star** the repository or topic, so you can easily find it again later. @@ -32,23 +32,23 @@ Once you've found something that interests you, you can: Once you star repositories or follow people, you will see updates on their activities on your {% data reusables.user-settings.personal_dashboard %}. -## Visit Explore {% data variables.product.prodname_dotcom %} +## Visit Explore {% data variables.product.github %} 1. Navigate to {% data variables.explore.explore_github %}. 1. Browse popular repositories and topics. 1. Click **{% octicon "star" aria-hidden="true" %} Star** next to repositories and topics that interest you, so you can easily find them again later. 1. Navigate to your {% data variables.explore.your_stars_page %} to see all your starred repositories and topics. -## Search for a topic or project on {% data variables.product.prodname_dotcom %} +## Search for a topic or project on {% data variables.product.github %} 1. Navigate to https://github.com/search. -1. Type a keyword or query into the search bar. {% ifversion fpt or ghec %}For example, try "how to build a webpage", or "skills-course".{% endif %} For more detailed information on how to search {% data variables.product.product_name %} for specific topics, repositories, or code, see [AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github). +1. Type a keyword or query into the search bar. {% ifversion fpt or ghec %}For example, try "how to build a webpage", or "skills-course".{% endif %} For more detailed information on how to search {% data variables.product.github %} for specific topics, repositories, or code, see [AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github). 1. Use the left sidebar to filter the results. {% ifversion fpt or ghec %}For example, to browse all repositories in the "skills-course" topic, search "skills-course", then filter by "Topic".{% endif %} 1. Star the repositories that match your interests. -## Following people and organizations on {% data variables.product.product_name %} +## Following people and organizations on {% data variables.product.github %} -Following people and organizations on {% data variables.product.product_name %} is another good way to stay updated on projects and topics that interest you. +Following people and organizations is another good way to stay updated on projects and topics that interest you. ### Following people @@ -68,7 +68,7 @@ Following people and organizations on {% data variables.product.product_name %} ## Next steps * {% data reusables.support.connect-in-the-forum-bootcamp %} -* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/downloading-files-from-github), you'll learn how to download files from {% data variables.product.product_name %} for your own use, and learn the differences between downloading, cloning, and forking repositories. +* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/downloading-files-from-github), you'll learn how to download files from {% data variables.product.github %} for your own use, and learn the differences between downloading, cloning, and forking repositories. ## Further reading diff --git a/content/get-started/start-your-journey/git-and-github-learning-resources.md b/content/get-started/start-your-journey/git-and-github-learning-resources.md index 4d01c8e897d0..2bbffc041347 100644 --- a/content/get-started/start-your-journey/git-and-github-learning-resources.md +++ b/content/get-started/start-your-journey/git-and-github-learning-resources.md @@ -7,7 +7,7 @@ redirect_from: - /github/getting-started-with-github/git-and-github-learning-resources - /github/getting-started-with-github/quickstart/git-and-github-learning-resources - /get-started/quickstart/git-and-github-learning-resources -intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources available.' +intro: 'There are a lot of helpful Git and {% data variables.product.github %} resources available.' versions: fpt: '*' ghes: '*' @@ -17,12 +17,12 @@ authors: shortTitle: Learning resources --- -## Using {% data variables.product.product_name %} +## Using {% data variables.product.github %} -Become better acquainted with {% data variables.product.product_name %} through our [AUTOTITLE](/get-started/using-github) articles: -* To review the fundamentals of a {% data variables.product.product_name %} workflow, see [AUTOTITLE](/get-started/using-github/github-flow). -* To learn about the various tools for working with repositories hosted on {% data variables.product.product_name %}, and how to choose a tool that best suits your needs, see [AUTOTITLE](/get-started/using-github/connecting-to-github). -* To understand the different communication tools on {% data variables.product.product_name %}, such as {% data variables.product.prodname_github_issues %}{% ifversion fpt or ghec %}, {% data variables.product.prodname_discussions %},{% endif %} and pull requests, see [AUTOTITLE](/get-started/using-github/communicating-on-github). +Become better acquainted with {% data variables.product.github %} through our [AUTOTITLE](/get-started/using-github) articles: +* To review the fundamentals of a {% data variables.product.github %} workflow, see [AUTOTITLE](/get-started/using-github/github-flow). +* To learn about the various tools for working with repositories hosted on {% data variables.product.github %}, and how to choose a tool that best suits your needs, see [AUTOTITLE](/get-started/using-github/connecting-to-github). +* To understand the different communication tools on {% data variables.product.github %}, such as {% data variables.product.prodname_github_issues %}{% ifversion fpt or ghec %}, {% data variables.product.prodname_discussions %},{% endif %} and pull requests, see [AUTOTITLE](/get-started/using-github/communicating-on-github). ## Using Git diff --git a/content/get-started/start-your-journey/hello-world.md b/content/get-started/start-your-journey/hello-world.md index cb8412ce8a54..a87e12b258c4 100644 --- a/content/get-started/start-your-journey/hello-world.md +++ b/content/get-started/start-your-journey/hello-world.md @@ -1,6 +1,6 @@ --- title: Hello World -intro: 'Follow this Hello World exercise to learn {% data variables.product.product_name %}''s pull request workflow.' +intro: 'Follow this Hello World exercise to learn {% data variables.product.github %}''s pull request workflow.' versions: fpt: '*' ghes: '*' @@ -15,20 +15,20 @@ redirect_from: ## Introduction -This tutorial teaches you {% data variables.product.product_name %} essentials like repositories, branches, commits, and pull requests. You'll create your own Hello World repository and learn {% data variables.product.product_name %}'s pull request workflow, a popular way to create and review code. +This tutorial teaches you {% data variables.product.github %} essentials like repositories, branches, commits, and pull requests. You'll create your own Hello World repository and learn {% data variables.product.github %}'s pull request workflow, a popular way to create and review code. In this quickstart guide, you will: * Create and use a repository. * Start and manage a new branch. -* Make changes to a file and push them to {% data variables.product.product_name %} as commits. +* Make changes to a file and push them to {% data variables.product.github %} as commits. * Open and merge a pull request. ### Prerequisites -* You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see [AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github).{% endif %} +* You must have a {% data variables.product.github %} account. {% ifversion fpt or ghec %}For more information, see [AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github).{% endif %} -* You don't need to know how to code, use the command line, or install Git (the version control software that {% data variables.product.product_name %} is built on). +* You don't need to know how to code, use the command line, or install Git (the version control software that {% data variables.product.github %} is built on). ## Step 1: Create a repository @@ -36,7 +36,7 @@ The first thing we'll do is create a repository. You can think of a repository a Often, repositories include a README file, a file with information about your project. README files are written in Markdown, which is an easy-to-read, easy-to-write language for formatting plain text. We'll learn more about Markdown in the next tutorial, [AUTOTITLE](/get-started/start-your-journey/setting-up-your-profile). -{% data variables.product.product_name %} lets you add a README file at the same time you create your new repository. {% data variables.product.product_name %} also offers other common options such as a license file, but you do not have to select any of them now. +{% data variables.product.github %} lets you add a README file at the same time you create your new repository. {% data variables.product.github %} also offers other common options such as a license file, but you do not have to select any of them now. Your `hello-world` repository can be a place where you store ideas, resources, or even share and discuss things with others. @@ -89,9 +89,9 @@ Now you have two branches, `main` and `readme-edits`. Right now, they look exact ## Step 3: Make and commit changes -When you created a new branch in the previous step, {% data variables.product.product_name %} brought you to the code page for your new `readme-edits` branch, which is a copy of `main`. +When you created a new branch in the previous step, {% data variables.product.github %} brought you to the code page for your new `readme-edits` branch, which is a copy of `main`. -You can make and save changes to the files in your repository. On {% data variables.product.product_name %}, saved changes are called commits. Each commit has an associated commit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes so that other contributors can understand what you’ve done and why. +You can make and save changes to the files in your repository. On {% data variables.product.github %}, saved changes are called commits. Each commit has an associated commit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes so that other contributors can understand what you’ve done and why. 1. Under the `readme-edits` branch you created, click the `README.md` file. 1. To edit the file, click {% octicon "pencil" aria-label="Edit file" %}. @@ -106,11 +106,11 @@ These changes will be made only to the README file on your `readme-edits` branch Now that you have changes in a branch off of `main`, you can open a pull request. -Pull requests are the heart of collaboration on {% data variables.product.product_name %}. When you open a pull request, you're proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests show diffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in different colors. +Pull requests are the heart of collaboration on {% data variables.product.github %}. When you open a pull request, you're proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests show diffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in different colors. As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished. -In this step, you'll open a pull request in your own repository and then merge it yourself. It's a great way to practice the {% data variables.product.product_name %} flow before working on larger projects. +In this step, you'll open a pull request in your own repository and then merge it yourself. It's a great way to practice the {% data variables.product.github %} flow before working on larger projects. 1. Click the **Pull requests** tab of your `hello-world` repository. 1. Click **New pull request**. @@ -133,7 +133,7 @@ We won't cover reviewing pull requests in this tutorial, but if you're intereste In this final step, you will merge your `readme-edits` branch into the `main` branch. After you merge your pull request, the changes on your `readme-edits` branch will be incorporated into `main`. -Sometimes, a pull request may introduce changes to code that conflict with the existing code on `main`. If there are any conflicts, {% data variables.product.product_name %} will alert you about the conflicting code and prevent merging until the conflicts are resolved. You can make a commit that resolves the conflicts or use comments in the pull request to discuss the conflicts with your team members. +Sometimes, a pull request may introduce changes to code that conflict with the existing code on `main`. If there are any conflicts, {% data variables.product.github %} will alert you about the conflicting code and prevent merging until the conflicts are resolved. You can make a commit that resolves the conflicts or use comments in the pull request to discuss the conflicts with your team members. In this walk-through, you should not have any conflicts, so you are ready to merge your branch into the main branch. @@ -144,20 +144,20 @@ In this walk-through, you should not have any conflicts, so you are ready to mer ## Conclusion -By completing this tutorial, you've learned to create a project and make a pull request on {% data variables.product.product_name %}. +By completing this tutorial, you've learned to create a project and make a pull request on {% data variables.product.github %}. As part of that, we've learned how to: * Create a repository. * Start and manage a new branch. -* Change a file and commit those changes to {% data variables.product.product_name %}. +* Change a file and commit those changes to {% data variables.product.github %}. * Open and merge a pull request. ## Next steps -* Take a look at your {% data variables.product.product_name %} profile and you'll see your work reflected on your contribution graph. +* Take a look at your {% data variables.product.github %} profile and you'll see your work reflected on your contribution graph. * If you want to practice the skills you've learned in this tutorial again, try the [{% data variables.product.prodname_learning %}](https://skills.github.com/) "Introduction to {% data variables.product.prodname_dotcom %}" course. -* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/setting-up-your-profile), you'll learn how to personalize your profile and you'll also learn some basic Markdown syntax for writing on {% data variables.product.product_name %}. +* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/setting-up-your-profile), you'll learn how to personalize your profile and you'll also learn some basic Markdown syntax for writing on {% data variables.product.github %}. ## Further reading diff --git a/content/get-started/start-your-journey/index.md b/content/get-started/start-your-journey/index.md index dcddf7fb6a06..7c6d81be2987 100644 --- a/content/get-started/start-your-journey/index.md +++ b/content/get-started/start-your-journey/index.md @@ -1,6 +1,6 @@ --- title: Start your journey -intro: 'Learn the basics of {% data variables.product.product_name %}.' +intro: 'Learn the basics of {% data variables.product.github %}.' versions: fpt: '*' ghes: '*' diff --git a/content/get-started/start-your-journey/setting-up-your-profile.md b/content/get-started/start-your-journey/setting-up-your-profile.md index 309018d2f6cb..9e585d2af9af 100644 --- a/content/get-started/start-your-journey/setting-up-your-profile.md +++ b/content/get-started/start-your-journey/setting-up-your-profile.md @@ -16,30 +16,30 @@ redirect_from: ## About your profile -Your profile page on {% data variables.product.prodname_dotcom %} is a place where people can find out more about you. You can use your profile to: +Your profile page on {% data variables.product.github %} is a place where people can find out more about you. You can use your profile to: * **Share** your interests and skills. * **Showcase** your projects and contributions. -* **Express** your identity{% ifversion fpt or ghec %} and show the {% data variables.product.prodname_dotcom %} community who you are{% endif %}. +* **Express** your identity{% ifversion fpt or ghec %} and show the {% data variables.product.github %} community who you are{% endif %}. In this tutorial, you'll learn how to personalize your profile by adding a profile picture, bio, and a profile README. -You'll also learn the basics of Markdown syntax, which is what you'll use to format any writing you do on {% data variables.product.prodname_dotcom %}. +You'll also learn the basics of Markdown syntax, which is what you'll use to format any writing you do on {% data variables.product.github %}. ### Prerequisites -* You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see [AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github).{% endif %} +* You must have a {% data variables.product.github %} account. {% ifversion fpt or ghec %}For more information, see [AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github).{% endif %} ## Adding a profile picture and bio -First, we'll add a picture to your profile. Your profile picture helps identify you across {% data variables.product.product_name %}. +First, we'll add a picture to your profile. Your profile picture helps identify you across {% data variables.product.github %}. ### Adding a profile picture 1. In the upper-right corner of any page, click your existing profile avatar, then, from the dropdown menu, click **Settings**. {% data reusables.accounts.set-profile-picture %} -Next, we'll add some basic information about yourself to share with other {% data variables.product.product_name %} users. This information will display below your profile picture on your profile page. +Next, we'll add some basic information about yourself to share with other {% data variables.product.github %} users. This information will display below your profile picture on your profile page. ### Adding a bio @@ -57,7 +57,7 @@ Next, we'll add some basic information about yourself to share with other {% dat Next, we'll create a special repository and README file that will be displayed directly on your profile page. -Your profile README contains information such as your interests, skills, and background, and it can be a great way to introduce yourself to other people on {% data variables.product.product_name %} and showcase your work. +Your profile README contains information such as your interests, skills, and background, and it can be a great way to introduce yourself to other people on {% data variables.product.github %} and showcase your work. As we learned in the [AUTOTITLE](/get-started/start-your-journey/hello-world) tutorial, `README.md` files are written using Markdown syntax (note the `.md` file extension), which is just a way to format plain text. @@ -93,7 +93,7 @@ In the following steps, we'll create and edit your profile README. * If you want to learn more Markdown syntax and add more sophisticated formatting to your profile README, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github). * Alternatively, try the [{% data variables.product.prodname_learning %}](https://skills.github.com/) "Communicate using Markdown" course. -* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/finding-inspiration-on-github), we'll look at ways you can explore {% data variables.product.product_name %} to find projects and people that interest you. +* In the next tutorial, [AUTOTITLE](/get-started/start-your-journey/finding-inspiration-on-github), we'll look at ways you can explore {% data variables.product.github %} to find projects and people that interest you. ## Further reading diff --git a/content/get-started/start-your-journey/uploading-a-project-to-github.md b/content/get-started/start-your-journey/uploading-a-project-to-github.md index 4cd74e3bdbbe..c63149011958 100644 --- a/content/get-started/start-your-journey/uploading-a-project-to-github.md +++ b/content/get-started/start-your-journey/uploading-a-project-to-github.md @@ -1,7 +1,7 @@ --- title: Uploading a project to GitHub shortTitle: Upload a project -intro: 'Learn how to upload the files for your project to {% data variables.product.prodname_dotcom %}.' +intro: 'Learn how to upload the files for your project to {% data variables.product.github %}.' versions: fpt: '*' ghec: '*' @@ -15,19 +15,19 @@ redirect_from: ## Introduction -This tutorial will show you how to upload a group of files to a {% data variables.product.prodname_dotcom %} repository. +This tutorial will show you how to upload a group of files to a {% data variables.product.github %} repository. -Uploading your files to a {% data variables.product.prodname_dotcom %} repository lets you: +Uploading your files to a {% data variables.product.github %} repository lets you: * **Apply version control** when you make edits to the files, so your project's history is protected and manageable. * **Back up** your work{% ifversion fpt or ghec %}, because your files are now stored in the cloud{% endif %}. * **Pin** the repository to your personal profile, so that others can see your work. * **Share** and discuss your work with others, either publicly or privately. -If you're already familiar with Git, and you're looking for information on how to upload a locally-stored Git repository to {% data variables.product.prodname_dotcom %}, see [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#adding-a-local-repository-to-github-using-git). +If you're already familiar with Git, and you're looking for information on how to upload a locally-stored Git repository to {% data variables.product.github %}, see [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#adding-a-local-repository-to-github-using-git). ## Prerequisites -* You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see [AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github).{% endif %} +* You must have a {% data variables.product.github %} account. {% ifversion fpt or ghec %}For more information, see [AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github).{% endif %} * You should have a group of files you'd like to upload. ## Step 1: Create a new repository for your project @@ -66,7 +66,7 @@ In this step, we'll edit your project's `README.md` using Markdown so that it in 1. Next, add some information about your project, such as a description of the project's purpose or its main features. > [!NOTE] - > If you're not sure what to write, take a look at other repositories on {% data variables.product.product_name %} to see how other people describe their projects. + > If you're not sure what to write, take a look at other repositories on {% data variables.product.github %} to see how other people describe their projects. > > To apply more sophisticated formatting, such as adding images, links, and footnotes, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). @@ -92,12 +92,12 @@ When making changes, remember that you can create a new branch from the `main` b ## Next steps -* Most people want to keep working on their files locally (i.e. on their own computer), and then continually sync these locally-made changes with this "remote" {% ifversion fpt or ghec %}(in the cloud){% endif %} repository on {% data variables.product.product_name %}. There are plenty of tools that let you do this, such as GitHub Desktop. To get started, you'd need to: +* Most people want to keep working on their files locally (i.e. on their own computer), and then continually sync these locally-made changes with this "remote" {% ifversion fpt or ghec %}(in the cloud){% endif %} repository on {% data variables.product.github %}. There are plenty of tools that let you do this, such as GitHub Desktop. To get started, you'd need to: * **Install** GitHub Desktop. For more information, see [AUTOTITLE](/desktop/overview/getting-started-with-github-desktop). * **Clone** the remote repository, so you have a copy of it on your own computer. For more information, see [AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop). * Continually **sync** your local changes with this remote repository. For more information, see [AUTOTITLE](/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop). -* To learn more about other tools available for working with repositories hosted on {% data variables.product.product_name %}, see [AUTOTITLE](/get-started/using-github/connecting-to-github). +* To learn more about other tools available for working with repositories hosted on {% data variables.product.github %}, see [AUTOTITLE](/get-started/using-github/connecting-to-github). ## Further reading diff --git a/content/get-started/using-github-docs/about-versions-of-github-docs.md b/content/get-started/using-github-docs/about-versions-of-github-docs.md index 91a94f73472e..b9d9bc74a096 100644 --- a/content/get-started/using-github-docs/about-versions-of-github-docs.md +++ b/content/get-started/using-github-docs/about-versions-of-github-docs.md @@ -21,7 +21,7 @@ At the top of a page on {% data variables.product.prodname_docs %}, select the d ![Screenshot of the header of {% data variables.product.prodname_docs %}. The "Version" dropdown menu is expanded and highlighted with an orange outline.](/assets/images/help/docs/version-picker.png) > [!NOTE] -> You can try changing the version now. You're viewing {% ifversion ghes %}a{% else %}the{% endif %} **{% ifversion fpt %}Free, Pro, & Team{% else %}{% data variables.product.product_name %}{% endif %}** version of this article. +> You can try changing the version now. You're viewing {% ifversion ghes %}a{% else %}the{% endif %} **{% ifversion fpt %}Free, Pro, & Team{% elsif ghec %}{% data variables.product.prodname_ghe_cloud %}{% elsif ghes %}{% data variables.product.prodname_ghe_server %}{% endif %}** version of this article. ## Determining which {% data variables.product.company_short %} product you use diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md index 483af9ad4c14..9fcf5fc523ea 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md @@ -20,11 +20,11 @@ You can also interact with other users in pull requests and issues using feature ## Text formatting toolbar -Every comment field on {% data variables.product.product_name %} contains a text formatting toolbar, which allows you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.product_name %}-specific features such as @-mentions, task lists, and links to issues and pull requests. +Every comment field on {% data variables.product.github %} contains a text formatting toolbar, which allows you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.github %}-specific features such as @-mentions, task lists, and links to issues and pull requests. ## Enabling fixed-width fonts in the editor -You can enable a fixed-width font in every comment field on {% data variables.product.product_name %}. Each character in a fixed-width, or monospace, font occupies the same horizontal space. This can make it easier to edit advanced Markdown structures such as tables and code snippets. +You can enable a fixed-width font in every comment field on {% data variables.product.github %}. Each character in a fixed-width, or monospace, font occupies the same horizontal space. This can make it easier to edit advanced Markdown structures such as tables and code snippets. ![Screenshot of a {% data variables.product.prodname_dotcom %} comment showing a sample Markdown table listing two Git commands. All letters in the table are the same visual width.](/assets/images/help/writing/fixed-width-example.png) diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index dc09efab7189..85d6856d6a78 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -120,7 +120,7 @@ You can also create a Markdown hyperlink by highlighting the text and using the ![Screenshot of rendered GitHub Markdown showing how text within brackets, "GitHub Pages," appears as a blue hyperlink.](/assets/images/help/writing/link-rendered.png) > [!NOTE] -> {% data variables.product.product_name %} automatically creates links when valid URLs are written in a comment. For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls). +> {% data variables.product.github %} automatically creates links when valid URLs are written in a comment. For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls). ## Section links @@ -245,7 +245,7 @@ You can display an image by adding ! and wrapping the alt text in `[ ![Screenshot of a comment on a GitHub issue showing an image, added in the Markdown, of an Octocat smiling and raising a tentacle.](/assets/images/help/writing/image-rendered.png) -{% data variables.product.product_name %} supports embedding images into your issues, pull requests{% ifversion fpt or ghec %}, discussions{% endif %}, comments and `.md` files. You can display an image from your repository, add a link to an online image, or upload an image. For more information, see [Uploading assets](#uploading-assets). +{% data variables.product.github %} supports embedding images into your issues, pull requests{% ifversion fpt or ghec %}, discussions{% endif %}, comments and `.md` files. You can display an image from your repository, add a link to an online image, or upload an image. For more information, see [Uploading assets](#uploading-assets). > [!NOTE] > When you want to display an image that is in your repository, use relative links instead of absolute links. @@ -295,7 +295,7 @@ To order your list, precede each line with a number. You can create a nested list by indenting one or more list items below another item. -To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), you can align your list visually. Type space characters in front of your nested list item until the list marker character (- or *) lies directly below the first character of the text in the item above it. +To create a nested list using the web editor on {% data variables.product.github %} or a text editor that uses a monospaced font, like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), you can align your list visually. Type space characters in front of your nested list item until the list marker character (- or *) lies directly below the first character of the text in the item above it. ```markdown 1. First list item @@ -310,7 +310,7 @@ To create a nested list using the web editor on {% data variables.product.produc ![Screenshot of rendered GitHub Markdown showing a numbered item followed by nested bullets at two different levels of nesting.](/assets/images/help/writing/nested-list-example-1.png) -To create a nested list in the comment editor on {% data variables.product.product_name %}, which doesn't use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item. +To create a nested list in the comment editor on {% data variables.product.github %}, which doesn't use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item. In this example, you could add a nested list item under the list item `100. First list item` by indenting the nested list item a minimum of five spaces, since there are five characters (`100. `) before `First list item`. @@ -345,7 +345,7 @@ For more information, see [AUTOTITLE](/get-started/writing-on-github/working-wit ## Mentioning people and teams -You can mention a person or [team](/organizations/organizing-members-into-teams) on {% data variables.product.product_name %} by typing @ plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). +You can mention a person or [team](/organizations/organizing-members-into-teams) on {% data variables.product.github %} by typing @ plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). > [!NOTE] > A person will only be notified about a mention if the person has read access to the repository and, if the repository is owned by an organization, the person is a member of the organization. @@ -415,7 +415,7 @@ The footnote will render like this: ## Alerts -Alerts are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the significance of the content. +Alerts are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. On {% data variables.product.github %}, they are displayed with distinctive colors and icons to indicate the significance of the content. Use alerts only when they are crucial for user success and limit them to one or two per article to prevent overloading the reader. Additionally, you should avoid placing alerts consecutively. Alerts cannot be nested within other elements. @@ -446,7 +446,7 @@ Here are the rendered alerts: ## Hiding content with comments -You can tell {% data variables.product.product_name %} to hide content from the rendered Markdown by placing the content in an HTML comment. +You can tell {% data variables.product.github %} to hide content from the rendered Markdown by placing the content in an HTML comment. ```text @@ -454,7 +454,7 @@ You can tell {% data variables.product.product_name %} to hide content from the ## Ignoring Markdown formatting -You can tell {% data variables.product.product_name %} to ignore (or escape) Markdown formatting by using \\ before the Markdown character. +You can tell {% data variables.product.github %} to ignore (or escape) Markdown formatting by using \\ before the Markdown character. `Let's rename \*our-new-project\* to \*our-old-project\*.` From 55c2a13894586f011a47b286ea24357a39bf2ef7 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:38:14 -0800 Subject: [PATCH 04/12] GraphQL schema update (#53962) Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com> --- src/graphql/data/fpt/changelog.json | 13 +++++++++++++ src/graphql/data/fpt/schema.docs.graphql | 5 +++++ src/graphql/data/fpt/schema.json | 8 ++++++++ src/graphql/data/ghec/schema.docs.graphql | 5 +++++ src/graphql/data/ghec/schema.json | 8 ++++++++ 5 files changed, 39 insertions(+) diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index 178140f6f8ac..ae2fa530ccd8 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,17 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Field updatedAt was added to object type Enterprise

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2025-01-16" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index 8ac297fae44c..7a189dbb49f0 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -13207,6 +13207,11 @@ type Enterprise implements AnnouncementBannerI & Node { """ slug: String! + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + """ The HTTP URL for this enterprise. """ diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index 48483ac32dfa..461d929e01b6 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -21799,6 +21799,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "updatedAt", + "description": "

Identifies the date and time when the object was last updated.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "url", "description": "

The HTTP URL for this enterprise.

", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index 8ac297fae44c..7a189dbb49f0 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -13207,6 +13207,11 @@ type Enterprise implements AnnouncementBannerI & Node { """ slug: String! + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + """ The HTTP URL for this enterprise. """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 48483ac32dfa..461d929e01b6 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -21799,6 +21799,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "updatedAt", + "description": "

Identifies the date and time when the object was last updated.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "url", "description": "

The HTTP URL for this enterprise.

", From f31a2216c9850104378d247b30cd4c3411b195dc Mon Sep 17 00:00:00 2001 From: Joe Clark <31087804+jc-clark@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:42:34 -0800 Subject: [PATCH 05/12] Hack week - add staging env to the self review checklist (#53944) --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c930eff3a2c4..04aff00c207c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,4 +18,4 @@ If you made changes to the `content` directory, a table will populate in a comme - [ ] A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff. - [ ] The changes in this PR meet [the docs fundamentals that are required for all content](http://docs.github.com/en/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals). -- [ ] All CI checks are passing. +- [ ] All CI checks are passing and the changes look good in the preview environment. From 195c0736bd2f9fdd6867e0d532bd740f63851748 Mon Sep 17 00:00:00 2001 From: Joe Clark <31087804+jc-clark@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:43:19 -0800 Subject: [PATCH 06/12] Hack week - delete self review article (#53943) --- .../collaborating-on-github-docs/index.md | 3 ++- .../self-review-checklist.md | 14 -------------- 2 files changed, 2 insertions(+), 15 deletions(-) delete mode 100644 content/contributing/collaborating-on-github-docs/self-review-checklist.md diff --git a/content/contributing/collaborating-on-github-docs/index.md b/content/contributing/collaborating-on-github-docs/index.md index 8ae1d2bf3f2b..27cc6559123c 100644 --- a/content/contributing/collaborating-on-github-docs/index.md +++ b/content/contributing/collaborating-on-github-docs/index.md @@ -4,11 +4,12 @@ shortTitle: Collaborate on GitHub Docs intro: 'Find out about collaborating on GitHub Docs.' versions: feature: 'contributing' +redirect_from: + - /contributing/collaborating-on-github-docs/self-review-checklist children: - /about-contributing-to-github-docs - /using-git-on-github-docs - /using-the-todocs-placeholder-to-leave-notes - /using-the-content-linter - /label-reference - - /self-review-checklist --- diff --git a/content/contributing/collaborating-on-github-docs/self-review-checklist.md b/content/contributing/collaborating-on-github-docs/self-review-checklist.md deleted file mode 100644 index 44f34afa3f56..000000000000 --- a/content/contributing/collaborating-on-github-docs/self-review-checklist.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Self review checklist -intro: "Before you submit your documentation pull request for review, you should first review it yourself." -versions: - feature: 'contributing' ---- - -Before you submit your changes to the {% data variables.product.prodname_docs %} team for review, work through the list below to complete your self review. - -* Changes meet the **content goals and user needs** in the content design plan, if one has been created. -* Content has been **confirmed for accuracy** by a subject matter expert (SME) in the technical area. -* Content satisfies {% data variables.product.github %}'s **documentation fundamentals** that are required for all content. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals). -* The article **renders properly on staging** for each version of the article (Free Pro Team, GHEC, GHES). -* All **pull request checks** are passing. From 55f3d72261b646d3e97097bba691acf25b2975b5 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:50:54 -0800 Subject: [PATCH 07/12] Update OpenAPI Description (#53963) Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 19 +++++++++++-------- src/rest/data/ghec-2022-11-28/schema.json | 19 +++++++++++-------- .../data/ghes-3.10-2022-11-28/schema.json | 19 +++++++++++-------- .../data/ghes-3.11-2022-11-28/schema.json | 19 +++++++++++-------- .../data/ghes-3.12-2022-11-28/schema.json | 19 +++++++++++-------- .../data/ghes-3.13-2022-11-28/schema.json | 19 +++++++++++-------- .../data/ghes-3.14-2022-11-28/schema.json | 19 +++++++++++-------- .../data/ghes-3.15-2022-11-28/schema.json | 19 +++++++++++-------- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 11 files changed, 91 insertions(+), 67 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index f45237b6ec41..9f8b5e5b588a 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "b1a9b605ce4d053e9554509fb4503109617a85f3" + "sha": "780e4964a55558c28e9bf35256510c3ad3882948" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 5f9c882def3e..35dd4ea420fa 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -231406,12 +231406,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -233269,12 +233270,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -235157,12 +235159,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -596045,7 +596048,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -597623,7 +597626,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 754026e870e8..2813ff0609bf 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -242888,12 +242888,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -244751,12 +244752,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -246639,12 +246641,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -635060,7 +635063,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -636638,7 +636641,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index ee9aaf59a9c6..5ead94b24e77 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -172454,12 +172454,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -174317,12 +174318,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -176205,12 +176207,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -494718,7 +494721,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -496296,7 +496299,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 821117e83005..e44e1dbd5674 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -172490,12 +172490,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -174353,12 +174354,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -176241,12 +176243,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -509433,7 +509436,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -511011,7 +511014,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 33cae5a1bf13..2926ca972d6a 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -172810,12 +172810,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -174673,12 +174674,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -176561,12 +176563,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -512988,7 +512991,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -514566,7 +514569,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index f3bf7c6bbe10..6be3333d31df 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -172954,12 +172954,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -174817,12 +174818,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -176705,12 +176707,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -516131,7 +516134,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -517709,7 +517712,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 610ef6ba7e5b..b1b2201ed8fe 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -172954,12 +172954,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -174817,12 +174818,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -176705,12 +176707,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -519932,7 +519935,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -521510,7 +521513,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index f7ec4f669b92..5e62cb35d791 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -177129,12 +177129,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -178992,12 +178993,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -180880,12 +180882,13 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", "schema": { "type": "string", "enum": [ "created", - "updated" + "updated", + "epss_percentage" ], "default": "created" } @@ -524803,7 +524806,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -526381,7 +526384,7 @@ } ], "previews": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 1238b5e39e05..1844bbcbca25 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -50,5 +50,5 @@ ] } }, - "sha": "b1a9b605ce4d053e9554509fb4503109617a85f3" + "sha": "780e4964a55558c28e9bf35256510c3ad3882948" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 08fa94769d84..2fc4dabfc6a6 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "b1a9b605ce4d053e9554509fb4503109617a85f3" + "sha": "780e4964a55558c28e9bf35256510c3ad3882948" } \ No newline at end of file From 23deba007dcf1991829563aa56813dc5b4299d4f Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 17:08:44 +0000 Subject: [PATCH 08/12] Hack week 2025: Fix alt text length in `content/issues` folder (#53959) --- .../editing-items-in-your-project.md | 4 ++-- .../managing-visibility-of-your-projects.md | 2 +- .../understanding-fields/about-iteration-fields.md | 2 +- .../about-insights-for-projects.md | 4 ++-- .../administering-issues/closing-an-issue.md | 2 +- .../marking-issues-or-pull-requests-as-a-duplicate.md | 4 ++-- .../planning-and-tracking-work-for-your-team-or-project.md | 4 ++-- .../filtering-and-searching-issues-and-pull-requests.md | 2 +- ...ing-and-editing-milestones-for-issues-and-pull-requests.md | 2 +- .../filtering-issues-and-pull-requests-by-milestone.md | 2 +- .../viewing-your-milestones-progress.md | 2 +- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md index 946456fd1243..25fb6630ba6c 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md +++ b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md @@ -40,7 +40,7 @@ You can quickly copy one cell's content over other cells in the same field by dr 1. Drag the handle up or down over the cells where you would like to copy the contents. - ![Screenshot showing two columns on a table layout. Three cells are selected. The blue handle, on the lower right of the cell, is highlighted with an orange outline.](/assets/images/help/projects-v2/bulk-cell-drag.png) + ![Screenshot showing two columns on a table layout. Three cells are selected. The blue handle, on the lower right of the cell, is outlined in orange.](/assets/images/help/projects-v2/bulk-cell-drag.png) 1. When you finish dragging, the contents of the originally selected cell will be copied over the cells you selected while dragging. @@ -56,7 +56,7 @@ You can quickly clear the same field for multiple items. {% indented_data_reference reusables.projects.select-a-cell spaces=4 %} ![Screenshot showing a column on a table layout. Three cells are selected.](/assets/images/help/projects-v2/select-multiple-cells.png) - + 1. Press Delete or Backspace on your keyboard. ## Undoing bulk changes in a table diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md index 554c77efbdc6..8835f8f09559 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md @@ -19,7 +19,7 @@ Project visibility can be set to {% ifversion ghec %}private, internal when usin Only the project visibility is affected; to view an item on the project, someone must have the required permissions for the repository that the item belongs to. Only people with access to a private repository will be able to view project items from that private repository. -![Screenshot showing a project using a table layout. One of the items is marked with a padlock icon, indicating it's hidden, and highlighted with an orange outline.](/assets/images/help/projects-v2/hidden-items.png) +![Screenshot showing a project using a table layout. One of the items is marked with a padlock icon, indicating it's hidden, and outlined in orange.](/assets/images/help/projects-v2/hidden-items.png) Project admins and organization owners can control project visibility. Organization owners{% ifversion project-visibility-policy %} and enterprise owners{% endif %} can restrict the ability to change project visibility to just organization owners. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md index 4608fa730ddc..4f6df6061e45 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md @@ -59,6 +59,6 @@ You can insert breaks into your iterations to communicate when you are taking ti 1. Click the name of the iteration field you want to adjust. 1. Hover over the dividing line above an iteration, then click **Insert break**. - ![Screenshot of the list of iterations for a project. On the dividing line between two iterations, a button, labeled "Insert break," is outlined in dark orange.](/assets/images/help/issues/iteration-insert-break.png) + ![Screenshot of the list of iterations for a project. On the line dividing two iterations, a button, labeled "Insert break," is outlined in orange.](/assets/images/help/issues/iteration-insert-break.png) 1. Optionally, to change the duration of the break, click on the date to open the calendar. Click on the start day, then click the end day, and then click **Apply**. 1. Click **Save changes**. diff --git a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md index 787874fdf18d..d7d7f4811b63 100644 --- a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md +++ b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md @@ -23,7 +23,7 @@ You can create current charts to visualize your project items. For example, you You can also use filters to manipulate the data used to build your chart. For example, you can create a chart showing how much upcoming work you have, but limit those results to particular labels or assignees. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). -![Screenshot of a stacked column chart, with a column for each iteration. Each column is divided into sections for "Bug", "Feedback", "Backend", and "UI."](/assets/images/help/issues/column-chart-example.png) +![Screenshot of a stacked column chart, with a column for each iteration. Each column is divided into "Bug", "Feedback", "Backend", and "UI" sections.](/assets/images/help/issues/column-chart-example.png) For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts). @@ -33,7 +33,7 @@ You can create historical charts to visualize your project items over time. Hist The default "Burn up" chart allows you to visualize the progress of your issues over time, showing how much work is completed and how much is left to do. You can use this chart to view progress, spot trends, and identify bottlenecks to help move the project forward. -![Screenshot of an example "Burn up" chart, showing the amount of issues over a two-week period split into the categories "Open", "Completed", and "Not planned". The chart uses horizontal lines to plot the number of issues in each category for each day in the two week period.](/assets/images/help/issues/burnup-example.png) +![Screenshot of a "Burn up" chart, showing the issues over a two-week period split into the categories: "Open", "Completed", and "Not planned".](/assets/images/help/issues/burnup-example.png) To create a historical chart, set your chart's X-axis to "Time." You can also use filters to manipulate the data used to build your chart. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md b/content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md index 5d83e24b028a..f03ad862fdfb 100644 --- a/content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md @@ -23,7 +23,7 @@ redirect_from: {%- ifversion issue-close-reasons %} 1. Optionally, to change your reason for closing the issue, next to "Close issue," select {% octicon "triangle-down" aria-label="Select close issue reason" %}, then click a reason. - ![Screenshot of the buttons at the bottom of an issue. A button, labeled with a downward triangle icon indicating a dropdown menu, is outlined in dark orange.](/assets/images/help/issues/close-issue-select-reason.png) + ![Screenshot of the buttons at the bottom of an issue. A button with a downward triangle icon, indicating a dropdown menu, is outlined in orange.](/assets/images/help/issues/close-issue-select-reason.png) 1. Click **Close issue**. {%- else %} 1. At the bottom of the comment box, click **Close issue**. diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md b/content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md index f7174e0cb813..1428a6ef4a7a 100644 --- a/content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md +++ b/content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md @@ -22,10 +22,10 @@ To mark an issue or pull request as a duplicate, type "Duplicate of" followed by You can also use the {% data variables.product.company_short %}-provided saved replies, "Duplicate issue" or "Duplicate pull request." For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies). -![Screenshot of an issue timeline, with a comment by octocat that says "Duplicate of #97" and a timeline event that says "octocat marked this as a duplicate of #97."](/assets/images/help/issues/duplicate-issue-syntax.png) +![Screenshot of an issue timeline, with a comment by octocat, "Duplicate of #97", and a timeline event "octocat marked this as a duplicate of #97."](/assets/images/help/issues/duplicate-issue-syntax.png) ## Unmarking duplicates You can unmark duplicate issues and pull requests by clicking **Undo** in the timeline. This will add a new timeline event, indicating that the issue or pull request was unmarked. -![Screenshot of an issue timeline. To the right of a timeline event about the issue being marked as duplicate, a button, labeled "Undo", is outlined in dark orange.](/assets/images/help/issues/unmark-duplicate-issue-button.png) +![Screenshot of an issue timeline. To the right of a timeline event where the issue was marked as a duplicate, an "Undo" button is outlined in orange.](/assets/images/help/issues/unmark-duplicate-issue-button.png) diff --git a/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md b/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md index 962a1233bd60..6cd8271cf049 100644 --- a/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md +++ b/content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md @@ -165,11 +165,11 @@ You can use {% data variables.projects.projects_v2 %} on {% data variables.produ Here is the table layout of an example project, populated with the Project Octocat issues we have created. -![Screenshot of the table view of the "Project Octocat" project, containing a list of issues, with columns for "Title," "Assignees," "Status," "Labels," and "Notes."](/assets/images/help/issues/quickstart-projects-table-view.png) +![Screenshot of the table view of a project, containing a list of issues, with columns for "Title," "Assignees," "Status," "Labels," and "Notes."](/assets/images/help/issues/quickstart-projects-table-view.png) We can also view the same project as a board. -![Screenshot of the board view of the "Project Octocat" project, with issues organized into columns for "No Status," "Todo," "In Progress," and "Done."](/assets/images/help/issues/quickstart-projects-board-view.png) +![Screenshot of the board view of a project, with issues organized into columns for "No Status," "Todo," "In Progress," and "Done."](/assets/images/help/issues/quickstart-projects-board-view.png) {% endif %} {% ifversion projects-v1 %} diff --git a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md index dde90726ebf2..e6347e67adc3 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md @@ -145,7 +145,7 @@ If your organization uses issue types, you can filter issues for a particular ty {% data reusables.repositories.sidebar-issues %} 1. Above the list of issues, select the **Types** dropdown menu. - ![Screenshot of a list of issues. In the header above the list, a dropdown menu, labeled "Types", is outlined in dark orange and the Issue Types menu is open.](/assets/images/help/issues/issue-type-dropdown.png) + ![Screenshot of a list of issues. In the header above the list, the "Types" dropdown menu is expanded and outlined in orange.](/assets/images/help/issues/issue-type-dropdown.png) 1. In the list of type, click an issue type. diff --git a/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md b/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md index 2d2ea369289d..ea42d6755641 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md +++ b/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md @@ -36,4 +36,4 @@ When you delete milestones, issues and pull requests are not affected. {% data reusables.project-management.milestones %} 1. Next to the milestone you want to delete, click **Delete**. -![Screenshot of the list of milestones for a repository. Within the entry for the "beta release" milestone, a red "Delete" link is outlined in dark orange.](/assets/images/help/repository/delete-milestone.png) +![Screenshot of the list of milestones for a repository. Within the entry for the "beta release" milestone, a red "Delete" link is outlined in orange.](/assets/images/help/repository/delete-milestone.png) diff --git a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md index c18c83b08064..db893f8a7306 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md +++ b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md @@ -23,7 +23,7 @@ shortTitle: Filter by milestone {% data reusables.repositories.sidebar-issue-pr %} 1. Select **Milestones** to see a list of all available milestones for the repository. - ![Screenshot of the list of issues for a repository. Above the list, a button, labeled with a signpost icon and "Milestones," is outlined in dark orange.](/assets/images/help/issues/issues-milestone-button.png) + ![Screenshot of the list of issues for a repository. Above the list, a "Milestones" button with a signpost icon and "Milestones," is outlined in orange.](/assets/images/help/issues/issues-milestone-button.png) 1. Select the milestone you're interested in from the list. You can view relevant information for the milestone, including all issues and pull requests associated with it, from the milestone page. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones). ## Further reading diff --git a/content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md b/content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md index 0861a5367752..1e169771dfe8 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md +++ b/content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md @@ -18,7 +18,7 @@ shortTitle: View progress to milestone {% data reusables.repositories.sidebar-issue-pr %} 1. In the upper-right corner, click **Milestones**. - ![Screenshot of the list of issues for a repository. Above the list, a button, labeled with a signpost icon and "Milestones," is outlined in dark orange.](/assets/images/help/issues/issues-milestone-button.png) + ![Screenshot of the list of issues for a repository. Above the list, a button, labeled with a signpost icon and "Milestones," is outlined in orange.](/assets/images/help/issues/issues-milestone-button.png) 1. Click the milestone you wish to see more information about. To better manage your project, you can prioritize issues or pull requests within a milestone. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones#prioritizing-issues-and-pull-requests-in-milestones). From bd337a6c1c47af5860690b8da35a247de63a6eb4 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 17:09:02 +0000 Subject: [PATCH 09/12] Hack week 2025: Fix alt text in `content` folders for Actions to GraphQL (#53958) --- .../creating-custom-deployment-protection-rules.md | 6 +++--- .../disabling-and-enabling-a-workflow.md | 2 +- .../downloading-workflow-artifacts.md | 2 +- content/actions/sharing-automations/required-workflows.md | 2 +- .../using-pre-written-building-blocks-in-your-workflow.md | 2 +- .../workflow-commands-for-github-actions.md | 2 +- .../about-discussions.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules.md b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules.md index 68aae5ecbf09..b8b9bc5b2a1d 100644 --- a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules.md +++ b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules.md @@ -41,11 +41,11 @@ Alternatively, you can write your own protection rules for any of the above use 1. Optionally, in the **Callback URL** text field under "Identifying and authorizing users," enter the callback URL. For more information, see [AUTOTITLE](/apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url). 1. Under "Permissions," select **Repository permissions**. 1. To the right of "Actions," click the drop down menu and select **Access: Read-only**. - ![Screenshot of the "Repository permissions" section when creating a new GitHub App. The button to configure permissions, with the "read-only" permission selected, for Actions is highlighted by a dark orange rectangle.](/assets/images/help/actions/actions-repo-permissions-read-only.png) + ![Screenshot of the "Repository permissions" section for a new GitHub App. The Actions permission shows "Read-only" and is outlined in orange.](/assets/images/help/actions/actions-repo-permissions-read-only.png) 1. To the right of "Deployments," click the drop down menu and select **Access: Read and write**. - ![Screenshot of the "Deployments" permission settings in the "Repository permissions" section while creating a new GitHub App. The button to configure permissions, with the "read-only" permission selected, for Deployments is highlighted by a dark orange rectangle.](/assets/images/help/actions/actions-deployments-repo-permissions-read-and-write.png) + ![Screenshot of the "Repository permissions" section for a new GitHub App. The Deployments permission shows "Read and write" and is outlined in orange.](/assets/images/help/actions/actions-deployments-repo-permissions-read-and-write.png) 1. Under "Subscribe to events," select **Deployment protection rule**. - ![Screenshot of the "Subscribe to events section" section while creating a new GitHub App. The checkbox to subscribe to the deployment protection rule event is highlighted by a dark orange rectangle.](/assets/images/help/actions/actions-subscribe-to-events-deployment-protection-rules.png) + ![Screenshot of the "Subscribe to events section" section for a new GitHub App. The checkbox for the Deployment protection rule is outlined in orange.](/assets/images/help/actions/actions-subscribe-to-events-deployment-protection-rules.png) 1. Install the custom deployment protection rule in your repositories and enable it for use. For more information, see [AUTOTITLE](/actions/deployment/protecting-deployments/configuring-custom-deployment-protection-rules). diff --git a/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow.md b/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow.md index b87a67073c99..3d7091596512 100644 --- a/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow.md +++ b/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow.md @@ -37,7 +37,7 @@ You can also disable and enable a workflow using the REST API. For more informat 1. Click {% octicon "kebab-horizontal" aria-label="Show workflow options" %} to display a dropdown menu and click **Disable workflow**. {% ifversion workflow-nav-2022 -%} - ![Screenshot of a workflow. The "Show workflow options" button, labeled with a horizontal kebab icon, and the "Disable workflow" menu item are outlined in dark orange.](/assets/images/help/repository/actions-disable-workflow-2022.png) + ![Screenshot of a workflow. The "Show workflow options" button, shown with a kebab icon, and the "Disable workflow" menu item are outlined in orange.](/assets/images/help/repository/actions-disable-workflow-2022.png) {%- else -%} ![Screenshot of a workflow. Features apart from the "Disable workflow" menu item are grayed out.](/assets/images/help/repository/actions-disable-workflow.png) diff --git a/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts.md index 21e60325f8a2..4646139e8a07 100644 --- a/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts.md @@ -25,7 +25,7 @@ By default, {% data variables.product.product_name %} stores build logs and arti {% data reusables.repositories.view-run %} 1. In the "Artifacts" section, click the artifact you want to download. - ![Screenshot of the "Artifacts" section of a workflow run. The name of an artifact generated by the run, "artifact," is highlighted with a dark orange outline.](/assets/images/help/repository/artifact-drop-down-updated.png) + ![Screenshot of the "Artifacts" section of a workflow run. The name of an artifact generated by the run, "artifact," is outlined in orange.](/assets/images/help/repository/artifact-drop-down-updated.png) {% endwebui %} diff --git a/content/actions/sharing-automations/required-workflows.md b/content/actions/sharing-automations/required-workflows.md index b8580826f40e..bbb7b0a06ec0 100644 --- a/content/actions/sharing-automations/required-workflows.md +++ b/content/actions/sharing-automations/required-workflows.md @@ -46,7 +46,7 @@ After a required workflow has run at least once in a repository, you can view it {% data reusables.repositories.actions-tab %} 1. In the left sidebar, you can view workflow runs for required workflows under "Required workflows." - ![Screenshot of the sidebar on the "Actions" page. A subsection, labeled "Required workflows", contains an entry called "Test required workflow" and is outlined in dark orange.](/assets/images/help/settings/view-required-workflows.png) + ![Screenshot of the sidebar on the "Actions" page. The "Required workflows" section lists "Test required workflow" and is outlined in orange.](/assets/images/help/settings/view-required-workflows.png) ## Adding a required workflow to an organization diff --git a/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md b/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md index 0fa34110b054..bf7b2e542644 100644 --- a/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md +++ b/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md @@ -54,7 +54,7 @@ You can search and browse actions directly in your repository's workflow editor. 1. In the upper right corner of the file view, to open the workflow editor, click {% octicon "pencil" aria-label="Edit file" %}. ![Screenshot of a workflow file showing the header section. The pencil icon for editing files is highlighted with a dark orange outline.](/assets/images/help/repository/actions-edit-workflow-file.png) 1. To the right of the editor, use the {% data variables.product.prodname_marketplace %} sidebar to browse actions. Actions with the {% octicon "verified" aria-label="Creator verified by GitHub" %} badge indicate {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization. - ![Screenshot of a workflow file in edit mode. The right sidebar shows Marketplace actions. A checkmark in a stamp icon, showing that the creator is verified by GitHub, is outlined in orange.](/assets/images/help/repository/actions-marketplace-sidebar.png) + ![Screenshot of a workflow in the file editor. The sidebar shows Marketplace actions. A "Creator verified by GitHub" badge is outlined in orange.](/assets/images/help/repository/actions-marketplace-sidebar.png) ## Adding an action to your workflow diff --git a/content/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions.md b/content/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions.md index 7fc6700248c4..b9f490c114a0 100644 --- a/content/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions.md +++ b/content/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions.md @@ -257,7 +257,7 @@ jobs: {% endpowershell %} -![Screenshot of the log for the workflow step. The second line, "My title", is prefaced by a downward arrow, indicating an expanded group. The next line, "Inside group", is indented below.](/assets/images/help/actions/actions-log-group.png) +![Screenshot of the log for the workflow step. The second line, "My title", is an expanded group. The next line, "Inside group", is indented below.](/assets/images/help/actions/actions-log-group.png) ## Masking a value in a log diff --git a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md index 82e81bcd846b..47826f0136c2 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md @@ -18,7 +18,7 @@ With {% data variables.product.prodname_discussions %}, the community for your p * Upvote discussions and comments to give higher visibility to ideas you find valuable * Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows -![Screenshot of the "Discussions" page for a {% data variables.product.company_short %} repository, showing a list of discussions such as "Feedback on the new layout" and "Project direction".](/assets/images/help/discussions/hero.png) +![Screenshot of the "Discussions" page for a repository, showing a list of discussions such as "Feedback on the new layout" and "Project direction".](/assets/images/help/discussions/hero.png) You might use repository discussions to discuss topics that are specific to the repository. If your project spans multiple repositories, you might use organization discussions to discuss topics that aren't specific to a single repository in your organization. From 9d03e0157e20b70c247bf32c789c7fefdba8436f Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 17:09:31 +0000 Subject: [PATCH 10/12] Hack week 2025: First batch of alt text fixes for the `data/reusables` folder (1) (#53954) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- data/reusables/actions/azure-vnet-network-communication.md | 2 +- data/reusables/dashboard/access-org-dashboard.md | 2 +- data/reusables/dotcom_billing/update_payment_method.md | 2 +- .../update_payment_method_organization_account.md | 2 +- .../dotcom_billing/update_payment_method_personal_account.md | 2 +- .../dotcom_billing/view-payment-history-personal-account.md | 2 +- data/reusables/dotcom_billing/view-payment-history.md | 2 +- data/reusables/files/add-file.md | 2 +- data/reusables/package_registry/about-packaging-and-actions.md | 3 +-- .../package_registry/package-settings-delete-versions.md | 2 +- data/reusables/pages/choose-visibility.md | 2 +- data/reusables/pages/settings-verify-domain-setup.md | 2 +- data/reusables/pages/visit-site.md | 2 +- 13 files changed, 13 insertions(+), 14 deletions(-) diff --git a/data/reusables/actions/azure-vnet-network-communication.md b/data/reusables/actions/azure-vnet-network-communication.md index bb6e1547808b..5703152de071 100644 --- a/data/reusables/actions/azure-vnet-network-communication.md +++ b/data/reusables/actions/azure-vnet-network-communication.md @@ -6,7 +6,7 @@ A NIC enables an Azure virtual machine (VM) to communicate with internet, Azure, >[!NOTE] {% data reusables.actions.azure-vnet-over-provisioning-resources %} -![Diagram of the network communication architecture between GitHub networks and your private networks. The diagram describes each step in connecting GitHub-hosted runners to an Azure VNET. Each step is numbered and the numbers correspond to the numbered descriptions of the step listed below the diagram.](/assets/images/help/actions/actions-vnet-injected-larger-runners-architecture.png) +![Diagram of network communication between GitHub and your private networks. Each step is numbered and corresponds to a step listed below the diagram.](/assets/images/help/actions/actions-vnet-injected-larger-runners-architecture.png) 1. A {% data variables.product.prodname_actions %} workflow is triggered. 1. The {% data variables.product.prodname_actions %} service creates a runner. diff --git a/data/reusables/dashboard/access-org-dashboard.md b/data/reusables/dashboard/access-org-dashboard.md index 37a93557aabe..91ea900c4e63 100644 --- a/data/reusables/dashboard/access-org-dashboard.md +++ b/data/reusables/dashboard/access-org-dashboard.md @@ -1,4 +1,4 @@ 1. To access the dashboard page, in the upper-left corner of any page on {% data variables.product.product_name %}, click the {% octicon "mark-github" aria-label="The github octocat logo" %}. 1. To switch to your organization dashboard, in the upper-left corner of the page, select your username, then from the dropdown menu, click the desired organization. - ![Screenshot of a dropdown menu on the dashboard page. The menu is expanded, labeled with the username of a personal account, and shows a list of organizations linked to the personal account.](/assets/images/help/dashboard/dashboard-context-switcher.png) + ![Screenshot of the "Switch dashboard context" menu for a personal account. The menu lists organizations linked to the personal account.](/assets/images/help/dashboard/dashboard-context-switcher.png) diff --git a/data/reusables/dotcom_billing/update_payment_method.md b/data/reusables/dotcom_billing/update_payment_method.md index 793645d6fcd1..1c45b2737512 100644 --- a/data/reusables/dotcom_billing/update_payment_method.md +++ b/data/reusables/dotcom_billing/update_payment_method.md @@ -1,2 +1,2 @@ 1. At the top of the page, under "Payment information", click **Update payment method**. - ![Screenshot of the summary section of the billing settings page. In the "Payment information" box, a link, labeled "Update payment method", is highlighted with an orange outline.](/assets/images/help/billing/update-payment-method.png) + ![Screenshot of the top of the billing settings page. In the "Payment information" box, the "Update payment method" link is outlined in orange.](/assets/images/help/billing/update-payment-method.png) diff --git a/data/reusables/dotcom_billing/update_payment_method_organization_account.md b/data/reusables/dotcom_billing/update_payment_method_organization_account.md index 52c91a288569..8fc0efc8edb3 100644 --- a/data/reusables/dotcom_billing/update_payment_method_organization_account.md +++ b/data/reusables/dotcom_billing/update_payment_method_organization_account.md @@ -1,3 +1,3 @@ 1. At the top of the page, click **Payment information** {% octicon "arrow-right" aria-hidden="true" %}. - ![Screenshot of the summary section of the billing settings page for an organization. A link, labeled "Payment information", is highlighted with an orange outline.](/assets/images/help/billing/update-payment-method-org.png) + ![Screenshot of the top of the billing settings page. In the "Payment information" box, the "Update payment method" link is outlined in orange.](/assets/images/help/billing/update-payment-method-org.png) diff --git a/data/reusables/dotcom_billing/update_payment_method_personal_account.md b/data/reusables/dotcom_billing/update_payment_method_personal_account.md index 5130e28256a5..596ac0040abb 100644 --- a/data/reusables/dotcom_billing/update_payment_method_personal_account.md +++ b/data/reusables/dotcom_billing/update_payment_method_personal_account.md @@ -1,3 +1,3 @@ 1. At the top of the page, click **Payment information** {% octicon "arrow-right" aria-hidden="true" %}. - ![Screenshot of the summary section of the billing settings page for a personal account. A link, labeled "Payment information", is highlighted with an orange outline.](/assets/images/help/billing/update-payment-method-personal-account.png) + ![Screenshot of the top of the billing settings page. In the "Payment information" box, the "Update payment method" link is outlined in orange.](/assets/images/help/billing/update-payment-method-personal-account.png) diff --git a/data/reusables/dotcom_billing/view-payment-history-personal-account.md b/data/reusables/dotcom_billing/view-payment-history-personal-account.md index bb936245f9ed..d54753b96cb4 100644 --- a/data/reusables/dotcom_billing/view-payment-history-personal-account.md +++ b/data/reusables/dotcom_billing/view-payment-history-personal-account.md @@ -1,3 +1,3 @@ 1. At the top of the page, under "Payment information", click **View payment history**. - ![Screenshot of the Billing Summary section of the payment information settings page. Under "Payment information", a link, labeled "View payment history", is highlighted with a dark orange outline.](/assets/images/help/billing/view-payment-history-link-personal-account.png) + ![Screenshot of the top of the payment information settings page. Under "Payment information", the "View payment history" link is outlined in orange.](/assets/images/help/billing/view-payment-history-link-personal-account.png) diff --git a/data/reusables/dotcom_billing/view-payment-history.md b/data/reusables/dotcom_billing/view-payment-history.md index 68f17fdfbf38..7b53b210635b 100644 --- a/data/reusables/dotcom_billing/view-payment-history.md +++ b/data/reusables/dotcom_billing/view-payment-history.md @@ -1,2 +1,2 @@ 1. At the top of the page, under "Next payment due", click **View payment history**. - ![Screenshot of the summary section of the billing settings page. In the "Next payment due" box, a link, labeled "View payment history", is highlighted with an orange outline.](/assets/images/help/billing/view-payment-history-link.png) + ![Screenshot of the top of the billing settings page. In the "Next payment due" box, the "View payment history" link is outlined in orange.](/assets/images/help/billing/view-payment-history-link.png) diff --git a/data/reusables/files/add-file.md b/data/reusables/files/add-file.md index 15e320cb1353..0ddbc2e16fe2 100644 --- a/data/reusables/files/add-file.md +++ b/data/reusables/files/add-file.md @@ -3,7 +3,7 @@ Alternatively, you can click {% octicon "plus" aria-label="The plus sign icon" %} in the file tree view on the left. - ![Screenshot of the main page of a repository. Above the list of files, a button, labeled "Add file," is outlined in dark orange. In the file tree view of the repository, a button with a plus sign icon is also outlined in dark orange.](/assets/images/help/repository/add-file-buttons.png) + ![Screenshot of the main page of a repository highlighting both the "Add file" and the "plus sign" icon, described above, with an orange outline.](/assets/images/help/repository/add-file-buttons.png) {% else %} 1. Above the list of files, using the **Add file** drop-down, click **Create new file**. {% endif %} diff --git a/data/reusables/package_registry/about-packaging-and-actions.md b/data/reusables/package_registry/about-packaging-and-actions.md index 866ab0372302..cfcd6ae3cdab 100644 --- a/data/reusables/package_registry/about-packaging-and-actions.md +++ b/data/reusables/package_registry/about-packaging-and-actions.md @@ -8,8 +8,7 @@ For example, a continuous integration workflow for a Java project may run `mvn p Now, when reviewing a pull request, you'll be able to look at the workflow run and download the artifact that was produced. -![Screenshot of the "Artifacts" section of a workflow run. The name of the artifact generated by the run, "artifact," is highlighted with a dark orange outline.](/assets/images/help/repository/artifact-drop-down-updated.png) - +![Screenshot of the "Artifacts" section of a workflow run. The name of the artifact generated by the run, "artifact," is outlined in orange.](/assets/images/help/repository/artifact-drop-down-updated.png) This will let you run the code in the pull request on your machine, which can help with debugging or testing the pull request. ## Workflows for publishing packages diff --git a/data/reusables/package_registry/package-settings-delete-versions.md b/data/reusables/package_registry/package-settings-delete-versions.md index 226121c1d3a6..566f45152b8e 100644 --- a/data/reusables/package_registry/package-settings-delete-versions.md +++ b/data/reusables/package_registry/package-settings-delete-versions.md @@ -1,5 +1,5 @@ 1. In the list of packages, find the version of the package that you want to delete. * _If your package is a container_, to the right of the package version click {% octicon "kebab-horizontal" aria-hidden="true" %}, then select **Delete version** from the dropdown menu. - ![Screenshot of a package version with a dropdown menu button, labeled with a kebab icon. The "Delete version" link in the menu is highlighted with an orange outline.](/assets/images/help/package-registry/delete-container-package-version.png) + ![Screenshot of a package version kebab button, expanded to show the menu. The "Delete version" link in the menu is outlined in orange.](/assets/images/help/package-registry/delete-container-package-version.png) * _For types of packages other than containers_, to the right of the package version click **Delete**. ![Screenshot of a package version with a "Delete" button. The button is highlighted with an orange outline.](/assets/images/help/package-registry/delete-noncontainer-package-version.png) diff --git a/data/reusables/pages/choose-visibility.md b/data/reusables/pages/choose-visibility.md index 537d397a06e0..a22f08a79270 100644 --- a/data/reusables/pages/choose-visibility.md +++ b/data/reusables/pages/choose-visibility.md @@ -1,5 +1,5 @@ {%- ifversion ghec %} 1. Optionally, if you're publishing a project site from a private or internal repository, choose the visibility for your site. Under "{% data variables.product.prodname_pages %}", select the visibility dropdown menu, then select public or private. - ![Screenshot of Pages settings in a {% data variables.product.prodname_dotcom %} repository. A menu to select private or public visibility of the Pages site, labeled "Private," is outlined in dark orange.](/assets/images/help/pages/public-or-private-visibility.png) + ![Screenshot of Pages settings for a repository. The visibility dropdown, currently set to "Private," is outlined in dark orange.](/assets/images/help/pages/public-or-private-visibility.png) {% indented_data_reference reusables.pages.privately-publish-ghec-only spaces=3 %} {%- endif %} diff --git a/data/reusables/pages/settings-verify-domain-setup.md b/data/reusables/pages/settings-verify-domain-setup.md index 6c1d6e8548a8..ed872302d608 100644 --- a/data/reusables/pages/settings-verify-domain-setup.md +++ b/data/reusables/pages/settings-verify-domain-setup.md @@ -1,5 +1,5 @@ 1. On the right, click **Add a domain**. 1. Under "What domain would you like to add?," enter the domain you wish to verify and select **Add domain**. - ![Screenshot of a text box to add a verified domain on {% data variables.product.prodname_pages %}, filled in with "example.com." Below the text is a green button labeled "Add domain."](/assets/images/help/pages/verify-enter-domain.png) + ![Screenshot of the field to add a verified domain for your {% data variables.product.prodname_pages %} site. A green "Add domain" button is shown below the field.](/assets/images/help/pages/verify-enter-domain.png) 1. Follow the instructions under "Add a DNS TXT record" to create the TXT record with your domain hosting service. ![Screenshot of {% data variables.product.prodname_pages %} instructions to add a TXT record to the DNS configuration of example.com.](/assets/images/help/pages/verify-dns.png) diff --git a/data/reusables/pages/visit-site.md b/data/reusables/pages/visit-site.md index 13462396799b..ad7d4517c2f8 100644 --- a/data/reusables/pages/visit-site.md +++ b/data/reusables/pages/visit-site.md @@ -1,4 +1,4 @@ 1. To see your published site, under "{% data variables.product.prodname_pages %}", click **{% octicon "link-external" aria-hidden="true" %} Visit site**. -![Screenshot of a confirmation message for {% data variables.product.prodname_pages %} listing the site's URL. To the right of the URL, a button labeled "Visit site" is outlined in dark orange.](/assets/images/help/pages/click-pages-url-to-preview.png) +![Screenshot of a confirmation message for {% data variables.product.prodname_pages %} listing the site's URL. The gray "Visit site" button is outlined in orange.](/assets/images/help/pages/click-pages-url-to-preview.png) {% data reusables.pages.twenty-minutes-to-publish %} From 31486e77476afe718004e3a80b664961eaba32c2 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 16 Jan 2025 17:18:45 +0000 Subject: [PATCH 11/12] Hack week 2025: Second batch of alt text fixes for the `data/reusables` folder (#53955) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> --- data/reusables/project-management/milestones.md | 2 +- data/reusables/reminders/times-dropdowns.md | 2 +- data/reusables/repositories/about-ruleset-insights.md | 2 +- data/reusables/repositories/accessing-repository-graphs.md | 2 +- .../repositories/actions-workflow-status-badge-intro.md | 2 +- data/reusables/repositories/create-ruleset-step.md | 2 +- data/reusables/repositories/disabling-markdown-rendering.md | 4 ++-- data/reusables/repositories/import-a-ruleset.md | 2 +- data/reusables/repositories/list-closed-pull-requests.md | 2 +- data/reusables/repositories/repo-name.md | 2 +- data/reusables/repositories/return-to-source-diff.md | 2 +- data/reusables/repositories/rulesets-view-rule-runs.md | 2 +- data/reusables/repositories/sidebar-issue-pr.md | 4 ++-- data/reusables/repositories/start-file-comment.md | 2 +- data/reusables/two_fa/edit-existing-method.md | 2 +- data/reusables/user-settings/deleted-repos.md | 2 +- data/reusables/user-settings/restore-repo.md | 2 +- 17 files changed, 19 insertions(+), 19 deletions(-) diff --git a/data/reusables/project-management/milestones.md b/data/reusables/project-management/milestones.md index 96d0ebe71a02..07c834d27253 100644 --- a/data/reusables/project-management/milestones.md +++ b/data/reusables/project-management/milestones.md @@ -1,3 +1,3 @@ 1. Next to the search field, click **Milestones**. - ![Screenshot of the list of issues for a repository. Above the list, a button, labeled with a signpost icon and "Milestones," is outlined in dark orange.](/assets/images/help/issues/issues-milestone-button.png) + ![Screenshot of the list of issues for a repository. Above the list, a button, labeled with a signpost icon and "Milestones," is outlined in orange.](/assets/images/help/issues/issues-milestone-button.png) diff --git a/data/reusables/reminders/times-dropdowns.md b/data/reusables/reminders/times-dropdowns.md index 99efa48eec3e..5df2c9afe1a1 100644 --- a/data/reusables/reminders/times-dropdowns.md +++ b/data/reusables/reminders/times-dropdowns.md @@ -1,2 +1,2 @@ 1. Under "Times", click **9:00 AM** {% octicon "triangle-down" aria-label="The down triangle icon" %} to select one or more times you'd like to receive scheduled reminders. Optionally, to change your timezone, click {% octicon "triangle-down" aria-label="The down triangle icon" %} next to your current timezone and select a different time zone. -![Screenshot of Scheduled reminder settings showing drop-down menus to select hours and the associated time zone for reminders in Slack. The hours menu is open, with checkmarks next to 9:00 AM and 10:00 AM.](/assets/images/help/settings/scheduled-reminders-times.png) +![Screenshot of Scheduled reminder options used to select the hour and time zone for reminders. 9:00 AM and 10:00 AM are checked in the open hours menu.](/assets/images/help/settings/scheduled-reminders-times.png) diff --git a/data/reusables/repositories/about-ruleset-insights.md b/data/reusables/repositories/about-ruleset-insights.md index 12018f856e3a..7aea341f244c 100644 --- a/data/reusables/repositories/about-ruleset-insights.md +++ b/data/reusables/repositories/about-ruleset-insights.md @@ -6,4 +6,4 @@ On the "Rule Insights" page, you will see a timeline of the following user actio If a ruleset is running in "Evaluate" mode, you can see actions that would have passed or failed if the ruleset had been active. -![Screenshot of the "Rule Insights" page. Three actions are listed: one marked "pass," one marked "bypass," and one marked "fail" with an "evaluate" label.](/assets/images/help/repository/rule-insights.png) +![Screenshot of the "Rule Insights" page. Three actions are listed marked: "Pass," "Bypass," and "Fail". The failed action has with an "evaluate" label.](/assets/images/help/repository/rule-insights.png) diff --git a/data/reusables/repositories/accessing-repository-graphs.md b/data/reusables/repositories/accessing-repository-graphs.md index 7b3f6e5da9df..ac48b2c5ec52 100644 --- a/data/reusables/repositories/accessing-repository-graphs.md +++ b/data/reusables/repositories/accessing-repository-graphs.md @@ -1,3 +1,3 @@ 1. Under your repository name, click **{% octicon "graph" aria-hidden="true" %} Insights**. - ![Screenshot of the main page of a repository. In the horizontal navigation bar, a tab, labeled with a graph icon and "Insights," is outlined in dark orange.](/assets/images/help/repository/repo-nav-insights-tab.png) + ![Screenshot of the main page of a repository. In the horizontal navigation bar, a tab, labeled with a graph icon and "Insights," is outlined in orange.](/assets/images/help/repository/repo-nav-insights-tab.png) diff --git a/data/reusables/repositories/actions-workflow-status-badge-intro.md b/data/reusables/repositories/actions-workflow-status-badge-intro.md index 989985cfe755..b94f0f56c76b 100644 --- a/data/reusables/repositories/actions-workflow-status-badge-intro.md +++ b/data/reusables/repositories/actions-workflow-status-badge-intro.md @@ -1,3 +1,3 @@ A status badge shows whether a workflow is currently failing or passing. A common place to add a status badge is in the `README.md` file of your repository, but you can add it to any web page you'd like. By default, badges display the status of your default branch. If there are no workflow runs on your default branch, it will display the status of the most recent run across all branches. You can display the status of a workflow run for a specific branch or event using the `branch` and `event` query parameters in the URL. -![Screenshot of a workflow status badge. The left side contains the octocat logo and "GitHub Actions Demo", the name of the workflow. The right half is green with the text "passing."](/assets/images/help/repository/actions-workflow-status-badge.png) +![Screenshot of a workflow status badge. From right to left it shows: the GitHub logo, workflow name ("GitHub Actions Demo"), and status ("passing").](/assets/images/help/repository/actions-workflow-status-badge.png) diff --git a/data/reusables/repositories/create-ruleset-step.md b/data/reusables/repositories/create-ruleset-step.md index c2ecd2c69ac5..16cab687f73b 100644 --- a/data/reusables/repositories/create-ruleset-step.md +++ b/data/reusables/repositories/create-ruleset-step.md @@ -6,5 +6,5 @@ * To create a ruleset targeting branches, click **New branch ruleset**. * To create a ruleset targeting tags, select {% octicon "triangle-down" aria-label="Open ruleset creation menu" %}, then click **New tag ruleset**. - ![Screenshot of the "Rulesets" page. Next to the "New branch ruleset" button, a dropdown menu is expanded, with an option labeled "New tag ruleset" outlined in orange.](/assets/images/help/repository/new-tag-ruleset.png) + ![Screenshot of the "Rulesets" page showing the "New branch ruleset" dropdown menu expanded. The "New tag ruleset" option is outlined in orange.](/assets/images/help/repository/new-tag-ruleset.png) {% endif %} diff --git a/data/reusables/repositories/disabling-markdown-rendering.md b/data/reusables/repositories/disabling-markdown-rendering.md index 23b1b66f594b..3b09acb3fb63 100644 --- a/data/reusables/repositories/disabling-markdown-rendering.md +++ b/data/reusables/repositories/disabling-markdown-rendering.md @@ -2,11 +2,11 @@ When viewing a Markdown file, you can click {% ifversion code-view-ui %}**Code** {% ifversion code-view-ui %} - ![Screenshot of a Markdown file in a {% data variables.product.prodname_dotcom %} repository showing options for interacting with the file. A button, labeled "Code", is outlined in dark orange.](/assets/images/help/writing/display-markdown-as-source-global-nav-update.png) + ![Screenshot of a Markdown file in a repository showing options for interacting with the file. A button, labeled "Code", is outlined in dark orange.](/assets/images/help/writing/display-markdown-as-source-global-nav-update.png) {% else %} - ![Screenshot of a Markdown file in a {% data variables.product.prodname_dotcom %} repository showing options for interacting with the file. The button to display the source blob is outlined in dark orange.](/assets/images/help/writing/display-markdown-as-source.png) + ![Screenshot of a Markdown file in a repository showing options for interacting with the file. The icon to display the code is outlined in orange.](/assets/images/help/writing/display-markdown-as-source.png) {% endif %} diff --git a/data/reusables/repositories/import-a-ruleset.md b/data/reusables/repositories/import-a-ruleset.md index 4c0909cfc880..3a5581f8219c 100644 --- a/data/reusables/repositories/import-a-ruleset.md +++ b/data/reusables/repositories/import-a-ruleset.md @@ -1,6 +1,6 @@ 1. Select the **New ruleset** dropdown, then click **Import a ruleset**. - ![Screenshot of the page for repository rulesets. A dropdown menu labeled "New ruleset" is expanded and the "Import a ruleset" option is highlighted with an orange outline.](/assets/images/help/repository/import-a-ruleset.png) + ![Screenshot of the page for repository rulesets. The "New ruleset" dropdown menu is expanded and the "Import a ruleset" option is outlined in orange.](/assets/images/help/repository/import-a-ruleset.png) 1. Open the exported JSON file. 1. Review the imported ruleset and click **Create**. diff --git a/data/reusables/repositories/list-closed-pull-requests.md b/data/reusables/repositories/list-closed-pull-requests.md index e2eaa5c70270..20e728cd943c 100644 --- a/data/reusables/repositories/list-closed-pull-requests.md +++ b/data/reusables/repositories/list-closed-pull-requests.md @@ -1,3 +1,3 @@ 1. To see a list of closed pull requests, click **Closed**. - ![Screenshot of the "Pull requests" page for a repository. A filter, labeled with a checkmark icon and "31 closed", is highlighted with an orange outline.](/assets/images/help/branches/branches-closed.png) + ![Screenshot of the "Pull requests" page for a repository. The "Closed" filter shows a checkmark icon and "31 closed". It is outlined in orange.](/assets/images/help/branches/branches-closed.png) diff --git a/data/reusables/repositories/repo-name.md b/data/reusables/repositories/repo-name.md index ab20e4b1ea03..7b5cd8a13106 100644 --- a/data/reusables/repositories/repo-name.md +++ b/data/reusables/repositories/repo-name.md @@ -1,3 +1,3 @@ 1. Type a name for your repository, and an optional description. - ![Screenshot of a the first step in creating a {% data variables.product.prodname_dotcom %} repository. The "Repository name" field contains the text "hello-world" and is outlined in dark orange.](/assets/images/help/repository/create-repository-name.png) + ![Screenshot of a the first step in creating a repository. The "Repository name" field contains the text "hello-world" and is outlined in orange.](/assets/images/help/repository/create-repository-name.png) diff --git a/data/reusables/repositories/return-to-source-diff.md b/data/reusables/repositories/return-to-source-diff.md index 12c9447a8819..80fc4865ddbe 100644 --- a/data/reusables/repositories/return-to-source-diff.md +++ b/data/reusables/repositories/return-to-source-diff.md @@ -2,4 +2,4 @@ To return to the source diff view, click the **{% octicon "code" aria-label="Display the source diff" %}** button. - ![Screenshot of the "Files changed" tab of a pull request. The button to display the source diff, which is labeled with a code icon, is outlined in dark orange.](/assets/images/help/pull_requests/dependency-review-source-diff.png) + ![Screenshot of the "Files changed" tab of a pull request. The button to display the source diff, shown with a code icon, is outlined in orange.](/assets/images/help/pull_requests/dependency-review-source-diff.png) diff --git a/data/reusables/repositories/rulesets-view-rule-runs.md b/data/reusables/repositories/rulesets-view-rule-runs.md index 052f62b59140..82666324fdfd 100644 --- a/data/reusables/repositories/rulesets-view-rule-runs.md +++ b/data/reusables/repositories/rulesets-view-rule-runs.md @@ -1,3 +1,3 @@ 1. To see which specific rules failed or required a bypass, click {% octicon "kebab-horizontal" aria-label="View rule runs" %}, then expand the name of the ruleset. - ![Screenshot of the "Rule Insights" page. To the right of an event labeled "octocat created not-allowed," an icon of three horizontal dots is outlined in orange.](/assets/images/help/repository/view-rule-runs.png) + ![Screenshot of the "Rule Insights" page. To the right of an event labeled "not-allowed," an icon of three horizontal dots is outlined in orange.](/assets/images/help/repository/view-rule-runs.png) diff --git a/data/reusables/repositories/sidebar-issue-pr.md b/data/reusables/repositories/sidebar-issue-pr.md index 768bb41993ef..e6fe0c99afdc 100644 --- a/data/reusables/repositories/sidebar-issue-pr.md +++ b/data/reusables/repositories/sidebar-issue-pr.md @@ -2,10 +2,10 @@ {% ifversion global-nav-update %} - ![Screenshot of the main page of a repository. In the horizontal navigation bar, two tabs, labeled "Issues" and "Pull requests," are each outlined in dark orange.](/assets/images/help/repository/repo-settings-issues-pull-requests-global-nav-update.png) + ![Screenshot of the main page of a repository. In the horizontal navigation bar, the "Issues" and "Pull requests" tabs are outlined in orange.](/assets/images/help/repository/repo-settings-issues-pull-requests-global-nav-update.png) {% else %} - ![Screenshot of the main page of a repository. In the horizontal navigation bar, two tabs, labeled "Issues" and "Pull requests," are each outlined in dark orange.](/assets/images/help/repository/repo-settings-issues-pull-requests.png) + ![Screenshot of the main page of a repository. In the horizontal navigation bar, the "Issues" and "Pull requests" tabs are outlined in orange.](/assets/images/help/repository/repo-settings-issues-pull-requests.png) {% endif %} diff --git a/data/reusables/repositories/start-file-comment.md b/data/reusables/repositories/start-file-comment.md index fa3c727cd839..f4e30d677f84 100644 --- a/data/reusables/repositories/start-file-comment.md +++ b/data/reusables/repositories/start-file-comment.md @@ -1,3 +1,3 @@ 1. To comment directly on a file, to the right of the file, click {% octicon "comment" aria-label="The comment icon" %} and type your comment. - ![Screenshot of an image file on the "Files changed" page of a pull request. To the right of the image file, a comment icon is highlighted with an orange outline.](/assets/images/help/pull_requests/pull-request-comment-on-file.png) + ![Screenshot of an image file on the "Files changed" page of a pull request. To the right of the file, a comment icon is outlined in orange.](/assets/images/help/pull_requests/pull-request-comment-on-file.png) diff --git a/data/reusables/two_fa/edit-existing-method.md b/data/reusables/two_fa/edit-existing-method.md index 2028aa2a4a85..bb513dddcbab 100644 --- a/data/reusables/two_fa/edit-existing-method.md +++ b/data/reusables/two_fa/edit-existing-method.md @@ -1,3 +1,3 @@ 1. In "Two-factor methods", find the method you want to modify. Next to that method, click **Edit**. If you have multiple methods configured, select {% octicon "kebab-horizontal" aria-label="Manage METHOD" %}, then click **Edit**. - ![Screenshot of the "Two-factor methods" settings. To the right of "Authenticator app," a dropdown menu, labeled with a kebab icon, is expanded and outlined in orange.](/assets/images/help/2fa/edit-2fa-method-dropdown.png) + ![Screenshot of the "Two-factor methods" settings. To the right of "Authenticator app," the kebab icon, is expanded and outlined in orange.](/assets/images/help/2fa/edit-2fa-method-dropdown.png) diff --git a/data/reusables/user-settings/deleted-repos.md b/data/reusables/user-settings/deleted-repos.md index 0f66733d218e..409789fd30ad 100644 --- a/data/reusables/user-settings/deleted-repos.md +++ b/data/reusables/user-settings/deleted-repos.md @@ -1,3 +1,3 @@ 1. Under "Repositories", click **Deleted repositories**. - ![Screenshot of the "Repositories" settings page. Above a list of repositories, a link in gray text, labeled "Deleted repositories," is outlined in orange.](/assets/images/help/settings/deleted-repos.png) + ![Screenshot of the "Repositories" settings page. Above a list of repositories, a gray "Deleted repositories" link is outlined in orange.](/assets/images/help/settings/deleted-repos.png) diff --git a/data/reusables/user-settings/restore-repo.md b/data/reusables/user-settings/restore-repo.md index 128524b44837..be0b9743e5d5 100644 --- a/data/reusables/user-settings/restore-repo.md +++ b/data/reusables/user-settings/restore-repo.md @@ -1,3 +1,3 @@ 1. Next to the repository you want to restore, click **Restore**. - ![Screenshot of a list entry for the "octocat/hello-world" repository. To the right of a repository's name, a button, labeled "Restore," is outlined in orange.](/assets/images/help/settings/restore-button.png) + ![Screenshot of a list entry for the "octocat/hello-world" repository. To the right of a repository's name, the "Restore" button is outlined in orange.](/assets/images/help/settings/restore-button.png) From 68005de4c5f0736fb5d544a28e71091795561842 Mon Sep 17 00:00:00 2001 From: Taylor Reis Date: Thu, 16 Jan 2025 10:28:20 -0700 Subject: [PATCH 12/12] Update saml-configuration-reference.md (#53961) Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> --- .../iam-configuration-reference/saml-configuration-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/admin/managing-iam/iam-configuration-reference/saml-configuration-reference.md b/content/admin/managing-iam/iam-configuration-reference/saml-configuration-reference.md index 24a9d261b237..88727445e691 100644 --- a/content/admin/managing-iam/iam-configuration-reference/saml-configuration-reference.md +++ b/content/admin/managing-iam/iam-configuration-reference/saml-configuration-reference.md @@ -107,7 +107,7 @@ To specify more than one value for an attribute, use multiple `` element or by signing the `` element. +* Your IdP must provide a single assertion in the response with a digital signature. You can accomplish this by signing the `` element or by signing the `` element. * Your IdP must provide a `` element as part of the `` element. You may use any persistent name identifier format. * Your IdP must include the `Recipient` attribute, which must be set to the ACS URL. The following example demonstrates the attribute.