From 23dc439972173464cc8102266bf9aa11d1d6f09c Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 29 Aug 2023 09:09:45 -0700 Subject: [PATCH 1/2] Followup filename guidance (#41581) --- content/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/README.md b/content/README.md index 5768f27c80d6..83de9b8b038d 100644 --- a/content/README.md +++ b/content/README.md @@ -301,11 +301,11 @@ A content file can have **two** types of versioning: ## Filenames -When adding a new article, the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) version of the article's [`title`](#title) frontmatter. For example, the article "[About GitHub CLI](https://docs.github.com/en/github-cli/github-cli/about-github-cli)" has a `title` frontmatter of `About GitHub CLI` and a filename of `about-github-cli.md`. +When adding a new article, the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of the article's [`title`](#title) frontmatter. For example, the article "[About GitHub CLI](https://docs.github.com/en/github-cli/github-cli/about-github-cli)" has a `title` frontmatter of `About GitHub CLI` and a filename of `about-github-cli.md`. Directory names for categories and map topics can match the `title` or `shortTitle` frontmatter. -For titles that have punctuation (such as "GitHub's Billing Plans"), you can omit punctuation in filenames (`githubs-billing-plans.md`). For titles that use Liquid variables (such as `About {% data variables.product.prodname_emus %}`), you can use the words that the Liquid renders as in filenames (`about-enterprise-managed-users.md`). A test will flag any discrepancies between title and filename. To override the requirement that titles and filenames match for a given article, you can add [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename) in the frontmatter. +For a title that contains punctuation (such as "GitHub's Billing Plans"), you can omit the punctuation in the filename (`githubs-billing-plans.md`). For a title that uses a Liquid variable (such as `About {% data variables.product.prodname_emus %}`), you can use the words that the Liquid renders as in the filename (`about-enterprise-managed-users.md`). A test will flag any discrepancies between title and filename. To override the requirement that titles and filenames match for a given article, you can add [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename) in the frontmatter. ## Whitespace control From 2650e8a37ab7c372e64ae9fae1ac263d9baf19de Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 29 Aug 2023 09:11:19 -0700 Subject: [PATCH 2/2] Remove `shortTitle` from "About security overview" (#40614) --- .../code-security/security-overview/about-security-overview.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/code-security/security-overview/about-security-overview.md b/content/code-security/security-overview/about-security-overview.md index 1b8514ca8a7c..b3d23bf52017 100644 --- a/content/code-security/security-overview/about-security-overview.md +++ b/content/code-security/security-overview/about-security-overview.md @@ -21,7 +21,6 @@ topics: - Organizations - Secret scanning - Teams -shortTitle: Security overview --- {% data reusables.security-overview.beta %}