Adding links to all skipped tests (#22037)

* adding links to all skipped tests

* updating links

tests/browser/browser.js

@@ -48,6 +48,7 @@ describe('browser search', () => {
     await page.setViewport(initialViewport)
   })
   // 404 page is statically generated with next, so search is not available, but may possibly be brought back
+  // Docs Engineering issue: 961
   it.skip('works on 404 error page', async () => {
     await page.goto('http://localhost:4001/en/404')
     await page.click('[data-testid=search] input[type="search"]')
@@ -438,6 +439,7 @@ describe('language banner', () => {
 })
 
 // Skipping because next/links are disabled by default for now
+// Docs Engineering issue: 962
 describe.skip('next/link client-side navigation', () => {
   jest.setTimeout(60 * 1000)
 

tests/content/category-pages.js

@@ -153,6 +153,7 @@ describe('category pages', () => {
         })
 
         // TODO: Unskip this test once the related script has been executed
+        // Docs Engineering issue: 963
         test.skip('slugified title matches parent directory name', () => {
           // Get the parent directory name
           const categoryDirPath = path.dirname(indexAbsPath)

tests/content/featured-links.js

@@ -32,7 +32,7 @@ describe('featuredLinks', () => {
       )
     })
 
-    // Skipped. See issues/923
+    // Skipped. Docs Engineering issue: 923
     test.skip('localized intro links link to localized pages', async () => {
       const $ = await getDOM('/ja')
       const $featuredLinks = $('[data-testid=article-list] a')

tests/content/site-data.js

@@ -49,6 +49,7 @@ describe('siteData module (English)', () => {
   })
 
   // TODO: re-enable once Janky flakyness is resolved
+  // Docs Engineering issue: 964
   test.skip('backfills missing translated site data with English values', async () => {
     const newFile = path.join(__dirname, '../../data/newfile.yml')
     await fs.writeFile(newFile, 'newvalue: bar')
@@ -84,6 +85,7 @@ describe('siteData module (English)', () => {
     expect(reusable.includes('1. ')).toBe(true)
   })
 
+  // Docs Engineering issue: 965
   test.skip('encodes bracketed parentheses to prevent them from becoming links', async () => {
     const reusable = get(data, 'ja.site.data.reusables.organizations.team_name')
     const expectation = `reusable should contain a bracket followed by a space. Actual value: ${reusable}`

tests/rendering/header.js

@@ -67,6 +67,7 @@ describe('header', () => {
       expect($('[data-testid=header-notification] a[href*="github.com/contact"]').length).toBe(1)
     })
 
+    // Docs Engineering issue: 966
     test.skip('does not display any notices for English', async () => {
       const $ = await getDOM('/en')
       expect($('[data-testid=header-notification]').length).toBe(0)
@@ -151,7 +152,7 @@ describe('header', () => {
       expect(ghe.text().trim()).toBe('Enterprise administrators')
     })
 
-    // Skipped. See issues/923
+    // Skipped. Docs Engineering issue: 923
     test.skip("point to homepages in the current page's language", async () => {
       const $ = await getDOM(
         '/ja/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests'

tests/rendering/page-titles.js

@@ -46,6 +46,7 @@ describe('page titles', () => {
   // TODO enable this once translated content has synced with the versioning changes
   // Note the expected translations may need to be updated, since the English title changed
   // from `GitHub.com Help Documentation` to `GitHub Documentation`
+  // Docs Engineering issue: 967
   test.skip('displays only the site name on localized homepages', async () => {
     expect((await getDOM('/cn'))('title').text()).toBe('GitHub 帮助文档')
     expect((await getDOM('/ja'))('title').text()).toBe('GitHub ヘルプドキュメント')

tests/rendering/server.js

@@ -636,6 +636,7 @@ describe('server', () => {
 
     // this oneoff redirect is temporarily disabled because it introduces too much complexity
     // we can reenable it down the road if needed
+    // Docs Engineering issue: 968
     test.skip('redirects versioned category page', async () => {
       const res = await get('/en/github/receiving-notifications-about-activity-on-github')
       expect(res.statusCode).toBe(301)
@@ -899,6 +900,7 @@ describe('search', () => {
   })
 
   // SKIPPING: Can we have duplicate IDs? search-input-container and search-results-container are duplicated for mobile and desktop
+  // Docs Engineering issue: 969
   it.skip('articles pages do not render any elements with duplicate IDs', async () => {
     const $ = await getDOM('/en/articles/accessing-an-organization')
     const ids = $('body')

tests/unit/openapi-schema.js

@@ -157,7 +157,7 @@ describe('x-codeSamples for @octokit/core.js', () => {
   })
 
   // skipped because the definition is current missing the `content-type` parameter
-  // See GitHub issue #155943
+  // GitHub GitHub issue: 155943
   test.skip('operation with content-type parameter', () => {
     const operation = findOperation('POST', '/markdown/raw')
     expect(isPlainObject(operation)).toBe(true)

tests/unit/page.js

@@ -403,6 +403,7 @@ describe('Page class', () => {
       ])
     })
 
+    // Docs Engineering issue: 970
     it.skip('renders learning tracks that have been defined', async () => {
       // getLinkData.mockImplementation((guides) => { return guides })
       const guides = ['/path/guide1', '/path/guide2']
@@ -486,6 +487,7 @@ describe('Page class', () => {
       expect(page.includeGuides).toStrictEqual(['/path/guide1', '/path/guide2', '/path/guide3'])
     })
 
+    // Docs Engineering issue: 971
     it.skip('renders guides and topics', async () => {
       /* getLinkData.mockImplementation(() => {
         return [{
@@ -553,10 +555,11 @@ describe('Page class', () => {
   })
 
   describe('page.versions frontmatter', () => {
+    // Docs Engineering issue: 972
     test.skip('pages that apply to older enterprise versions', async () => {
       // There are none of these in the content at this time!
     })
-
+    // Docs Engineering issue: 972
     test.skip('pages that apply to newer enterprise versions', async () => {
       // There are none of these in the content at this time!
     })

tests/unit/pages.js

@@ -149,6 +149,7 @@ describe('pages module', () => {
       expect(liquidErrors.length, failureMessage).toBe(0)
     })
 
+    // Docs PR: 20035
     test.skip('every non-English page has a matching English page', async () => {
       const englishPaths = chain(pages)
         .filter((page) => page.languageCode === 'en')