Allow filename to match short title (#56673)

Co-authored-by: Copilot <[email protected]>

Author: sarahs

src/content-render/scripts/reconcile-filenames-with-ids.js

@@ -38,22 +38,25 @@ contentFiles.forEach((oldFullPath) => {
   // skip pages with frontmatter flag
   if (data.allowTitleToDifferFromFilename) return
 
-  // slugify the title of each article
-  // where title = Foo bar
-  // and slug = foo-bar
+  // Slugify the title of each article, where:
+  // * title = Foo bar
+  // * slug = foo-bar
+  // Also allow for the slugified shortTitle to match the filename.
   slugger.reset()
-  const slug = slugger.slug(decode(data.title))
+  const slugTitle = slugger.slug(decode(data.title))
+  const slugShortTitle = slugger.slug(decode(data.shortTitle))
+  const allowedSlugs = [slugTitle, slugShortTitle]
 
   // get the basename of each file
   // where file = content/foo-bar.md
   // and basename = foo-bar
   const basename = path.basename(oldFullPath, '.md')
 
-  // if slug and basename match, return early
-  if (basename === slug) return
+  // If the basename is one of the allowed slugs, we're all set here.
+  if (allowedSlugs.includes(basename)) return
 
   // otherwise rename the file using the slug
-  const newFullPath = oldFullPath.replace(basename, slug)
+  const newFullPath = oldFullPath.replace(basename, slugShortTitle || slugTitle)
 
   const oldContentPath = path.relative(process.cwd(), oldFullPath)
   const newContentPath = path.relative(process.cwd(), newFullPath)

src/frame/tests/pages.js

@@ -89,15 +89,16 @@ describe('pages module', () => {
       expect(duplicates.length, message).toBe(0)
     })
 
-    test('every English page has a filename that matches its slugified title', async () => {
+    test('every English page has a filename that matches its slugified title or shortTitle', async () => {
       const nonMatches = pages
         .filter((page) => {
           slugger.reset()
           return (
             page.languageCode === 'en' && // only check English
             !page.relativePath.includes('index.md') && // ignore TOCs
             !page.allowTitleToDifferFromFilename && // ignore docs with override
-            slugger.slug(decode(page.title)) !== path.basename(page.relativePath, '.md')
+            slugger.slug(decode(page.title)) !== path.basename(page.relativePath, '.md') &&
+            slugger.slug(decode(page.shortTitle || '')) !== path.basename(page.relativePath, '.md')
           )
         })
         // make the output easier to read