diff --git a/content/actions/concepts/runners/github-hosted-runners.md b/content/actions/concepts/runners/github-hosted-runners.md index 9e8bdb31434b..d326fccb75a1 100644 --- a/content/actions/concepts/runners/github-hosted-runners.md +++ b/content/actions/concepts/runners/github-hosted-runners.md @@ -54,7 +54,7 @@ Using {% data variables.product.prodname_dotcom %}-hosted runners requires netwo ## 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 images are partner images, and those are managed in the [`actions/partner-runner-images`](https://github.com/actions/partner-runner-images) repository. +{% data variables.product.github %} maintains our own set of VM images for our standard hosted runners. The list of images and their included tools are managed in the [`actions/runner-images`](https://github.com/actions/runner-images) repository. ### Preinstalled software for GitHub-owned images diff --git a/content/actions/reference/runners/larger-runners.md b/content/actions/reference/runners/larger-runners.md index bdf17bf692a3..8012bcc14401 100644 --- a/content/actions/reference/runners/larger-runners.md +++ b/content/actions/reference/runners/larger-runners.md @@ -54,13 +54,12 @@ You can choose from several specifications for {% data variables.actions.hosted_ {% data variables.actions.hosted_runner_caps %}s run on virtual machines (VMs), and {% data variables.product.prodname_dotcom %} installs a virtual hard disk (VHD) on this machine during the VM creation process. You can choose from different VM images to install on your runners. -**{% data variables.product.prodname_dotcom %}-owned images:** These images are maintained by {% data variables.product.prodname_dotcom %} and are available for Linux x64, Windows x64, and macOS (x64 and arm) runners. For more information on these images and a full list of included tools for each runner operating system, see the [{% data variables.product.prodname_actions %} Runner Images](https://github.com/actions/runner-images) repository. +**{% data variables.product.prodname_dotcom %}-owned images:** These images are maintained by {% data variables.product.prodname_dotcom %} and are available for Linux (x64 and arm64), Windows (x64 and arm64), and macOS (x64 and arm64) runners. For more information on these images and a full list of included tools for each runner operating system, see the [{% data variables.product.prodname_actions %} Runner Images](https://github.com/actions/runner-images) repository. **Partner Images:** Partner images are not managed by {% data variables.product.prodname_dotcom %} and are pulled from the Azure Marketplace. See below for resources on where to find more information and to report issues for partner images. * [Base Windows 11 desktop image](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/microsoftwindowsdesktop.windows-11?tab=Overview). * [NVIDIA GPU-Optimized VMI](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/nvidia.ngc_azure_17_11) * [Data Science Virtual Machine - Windows 2019](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/microsoft-dsvm.dsvm-win-2019?tab=overview). - * arm64 images: [`actions/partner-runner-images` repository](https://github.com/actions/partner-runner-images). ## Available macOS {% data variables.actions.hosted_runners %} and labels diff --git a/content/actions/reference/security/secure-use.md b/content/actions/reference/security/secure-use.md index 27e343b65c64..3d97018b65a6 100644 --- a/content/actions/reference/security/secure-use.md +++ b/content/actions/reference/security/secure-use.md @@ -239,9 +239,7 @@ For more information on how to enable {% data variables.product.prodname_code_sc For {% data variables.product.prodname_dotcom %}-hosted runners created from images maintained by {% data variables.product.company_short %}, you can view a software bill of materials (SBOM) to see what software was pre-installed on the runner. You can provide your users with the SBOM which they can run through a vulnerability scanner to validate if there are any vulnerabilities in the product. If you are building artifacts, you can include this SBOM in your bill of materials for a comprehensive list of everything that went into creating your software. -SBOMs are available for Ubuntu, Windows, and macOS runner images maintained by {% data variables.product.company_short %}. You can locate the SBOM for your build in the release assets at https://github.com/actions/runner-images/releases. An SBOM with a filename in the format of `sbom.IMAGE-NAME.json.zip` can be found in the attachments of each release. - -For third-party images, such as the images for ARM-powered runners, you can find details of the software that's included in the image in the [`actions/partner-runner-images` repository](https://github.com/actions/partner-runner-images). +SBOMs are available for Ubuntu, Windows, and macOS runner images maintained by {% data variables.product.company_short %}, including ARM-powered runners. You can locate the SBOM for your build in the release assets at https://github.com/actions/runner-images/releases. An SBOM with a filename in the format of `sbom.IMAGE-NAME.json.zip` can be found in the attachments of each release. {% endif %} diff --git a/content/contributing/style-guide-and-content-model/conceptual-content-type.md b/content/contributing/style-guide-and-content-model/concepts-content-type.md similarity index 57% rename from content/contributing/style-guide-and-content-model/conceptual-content-type.md rename to content/contributing/style-guide-and-content-model/concepts-content-type.md index 9d1d311d9e70..9bca16672d17 100644 --- a/content/contributing/style-guide-and-content-model/conceptual-content-type.md +++ b/content/contributing/style-guide-and-content-model/concepts-content-type.md @@ -1,32 +1,39 @@ --- -title: Conceptual content type +title: Concepts content type intro: People most often use conceptual content when they are learning about something new to them. +category: + - Follow the style guide and content model versions: fpt: '*' ghec: '*' ghes: '*' -category: - - Follow the style guide and content model +redirect_from: + - /contributing/style-guide-and-content-model/conceptual-content-type --- Conceptual content helps people understand a feature or topic by providing a clear, high-level overview, explanation of how the feature or topic can help them on their journey, and context like use cases or examples. -We create conceptual articles and conceptual sections within other articles. Most major products, features, or subjects have their own conceptual article. +We create concepts articles and conceptual sections within other articles. Most major products, features, or subjects have their own concepts article. + +## Deciding between an article or a section + +How-tos or tutorials can have 1-2 brief introductory sentences before the steps. If more explanation beyond a couple of sentences is needed, that’s when we should consider whether it merits a spot in a concepts article. + +However, we should be selective. Not every concept or “About X” section needs its own article. Generally this comes down to how much information will be useful to the user that we need to include. ## How to write conceptual content -For the conceptual content template, see [AUTOTITLE](/contributing/writing-for-github-docs/templates#conceptual-article-template). +For the conceptual content template, see [AUTOTITLE](/contributing/writing-for-github-docs/templates#concepts-article-template). * Describe in plain language what the feature, product, or topic is. * Describe its purpose and why it’s useful to the reader. * Share use cases or examples. -* If relevant, describe how the feature or topic works (be mindful of audience and the right location for deep dives into technical details). -* Highlight any details the reader needs to know to use the feature. -* Include next steps for getting started with the feature (whether through further reading links or content within the article itself). ## Titles for conceptual content -* Conceptual articles or headers of conceptual sections start with "About [subject]”. +Short titles for articles should be one word or a noun phrase. If the articles appear under Concepts in the sidebar avoid using "About", unless the article appears under a heading of the same name. Ex: "Coding agent" and "About coding agent". + +Headers of conceptual sections in articles start with "About [subject]”. * Use a noun to describe the subject. * Use: "About {% data variables.product.prodname_code_scanning %}" * Avoid: "About scanning your code for vulnerabilities" diff --git a/content/contributing/style-guide-and-content-model/index.md b/content/contributing/style-guide-and-content-model/index.md index f22a95f2bb17..d2f97a6d2b53 100644 --- a/content/contributing/style-guide-and-content-model/index.md +++ b/content/contributing/style-guide-and-content-model/index.md @@ -9,7 +9,7 @@ children: - /style-guide - /about-the-content-model - /contents-of-a-github-docs-article - - /conceptual-content-type + - /concepts-content-type - /reference-content-type - /how-to-content-type - /troubleshooting-content-type diff --git a/content/contributing/writing-for-github-docs/templates.md b/content/contributing/writing-for-github-docs/templates.md index b12e93a9f868..6108fdaea765 100644 --- a/content/contributing/writing-for-github-docs/templates.md +++ b/content/contributing/writing-for-github-docs/templates.md @@ -9,9 +9,9 @@ category: - Follow the style guide and content model --- -## Conceptual article template +## Concepts article template -Use the content model for full instructions and examples on how to write conceptual content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/conceptual-content-type). +Use the content model for full instructions and examples on how to write conceptual content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/concepts-content-type). @@ -27,7 +27,7 @@ versions: --- {% comment %} -- Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model#conceptual to write this article. +- Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model to write this article. - Great intros give readers a quick understanding of what's in the article, so they can tell whether it's relevant to them before moving ahead. For more tips, see https://docs.github.com/contributing/writing-for-github-docs/content-model - For product callout info, see https://github.com/github/docs/tree/main/content#product - For product version instructions, see https://github.com/github/docs/tree/main/content#versioning diff --git a/data/reusables/actions/supported-github-runners.md b/data/reusables/actions/supported-github-runners.md index 275f99ea2ede..952101c236fb 100644 --- a/data/reusables/actions/supported-github-runners.md +++ b/data/reusables/actions/supported-github-runners.md @@ -58,7 +58,7 @@ For public repositories, jobs using the workflow labels shown in the table below
windows-11-arm
+ windows-11-arm
windows-11-arm
+ windows-11-arm