From 53f297b243cc186384becaa9cc7d656942f61a91 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Wed, 15 Nov 2023 13:36:22 -0500 Subject: [PATCH] Mention about `index.md` and `versions` (#46179) --- .../writing-for-github-docs/using-yaml-frontmatter.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md b/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md index 8eb2754b44..f12678b67c 100644 --- a/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md +++ b/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md @@ -50,6 +50,7 @@ For more information about the different types of versioning, see "[Versioning d - Type: `Object`. Allowable keys map to product names and can be found in the `versions` object in [`lib/frontmatter.js`](https://github.com/github/docs/blob/main/src/frame/lib/frontmatter.js). - This frontmatter value is currently **required** for all pages. - The `*` is used to denote all releases for the version. +- Must be present for all `index.md` files, but actual value is computed at runtime based on the children. This frontmatter value is used by the docs site to generate "permalinks" for each version of an article. For more information, see [Permalinks](#permalinks). @@ -59,7 +60,7 @@ Example that applies to {% data variables.product.prodname_dotcom_the_website %} title: About your personal dashboard versions: fpt: '*' - ghes: '>=2.20' + ghes: '>=3.11' ``` Example that applies to all supported versions of {% data variables.product.prodname_ghe_server %}, but not {% data variables.product.prodname_dotcom_the_website %}: @@ -89,9 +90,9 @@ Example: ```yaml title: Getting started with GitHub Desktop redirect_from: - - /articles/first-launch/ - - /articles/error-github-enterprise-version-is-too-old/ - - /articles/getting-started-with-github-for-windows/ + - /articles/first-launch + - /articles/error-github-enterprise-version-is-too-old + - /articles/getting-started-with-github-for-windows ``` For more information, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/configuring-redirects)."