feat: update on-links (#19235)

estrada9166 · web-flow · commit cc2d7348185e · 2021-12-03T13:23:44.000-05:00
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@
 
 [![npm version](https://badge.fury.io/js/cypress.svg)](https://badge.fury.io/js/cypress)
 
-Install Cypress for Mac, Linux, or Windows, then [get started](https://docs.cypress.io/guides/getting-started/installing-cypress.html).
+Install Cypress for Mac, Linux, or Windows, then [get started](https://on.cypress.io/install).
 
 ```bash
 npm install cypress --save-dev
diff --git a/npm/create-cypress-tests/src/component-testing/init-component-testing.ts b/npm/create-cypress-tests/src/component-testing/init-component-testing.ts
@@ -84,7 +84,7 @@ async function injectAndShowPluginConfig<T> (template: Template<T>, {
     code: await getPluginsSourceExample(ast),
     language: 'js',
     filePath: pluginsFilePath,
-    fallbackFileMessage: 'plugins file (https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests.html#Plugin-files)',
+    fallbackFileMessage: 'plugins file (https://on.cypress.io/plugins-file)',
   })
 }
 
diff --git a/npm/cypress-schematic/README.md b/npm/cypress-schematic/README.md
@@ -84,7 +84,7 @@ Read our docs to learn more about [launching browsers](https://on.cypress.io/lau
 
 ### Recording test results to the Cypress Dashboard
 
-We recommend setting your [Cypress Dashboard](https://docs.cypress.io/guides/dashboard/introduction) recording key as an environment variable and NOT as a builder option when running it in CI.
+We recommend setting your [Cypress Dashboard](https://on.cypress.io/features-dashboard) recording key as an environment variable and NOT as a builder option when running it in CI.
 
 ```json
 "cypress-run": {
@@ -102,7 +102,7 @@ We recommend setting your [Cypress Dashboard](https://docs.cypress.io/guides/das
 }
 ```
 
-Read our docs to learn more about [recording test results](https://on.cypress.io/recording-project-runs) to the [Cypress Dashboard](https://docs.cypress.io/guides/dashboard/introduction).
+Read our docs to learn more about [recording test results](https://on.cypress.io/recording-project-runs) to the [Cypress Dashboard](https://on.cypress.io/features-dashboard).
 
 ### Specifying a custom `cypress.json` config file
 
diff --git a/npm/react/CHANGELOG.md b/npm/react/CHANGELOG.md
@@ -242,7 +242,7 @@
 
 * Added the need to install a preprocessor or a dev-server plugin
 * Removed the pre-instalation of test coverage 
-  * Install it manually by following [the documentation](https://docs.cypress.io/guides/tooling/code-coverage.html#Introduction)
+  * Install it manually by following [the documentation](https://on.cypress.io/code-coverage-introduction)
 * removed the pre-installation of `cypress-react-selector`
   * If you use `cy.react()` in your tests, the command will not work anymore. [Install it back in your support file](https://www.npmjs.com/package/cypress-react-selector) 
 
diff --git a/npm/react/examples/find-webpack/README.md b/npm/react/examples/find-webpack/README.md
@@ -35,7 +35,7 @@ Next, create a `cypress.json` with some basic configuration:
 
 Here we are adding some Component Testing specific options, hence the `"component"` key. `"componentFolder"` is where all the components and tests are located, and `"testFiles"` is the pattern to search for test files.
 
-The last thing we need to is tell Cypress to use `@cypress/webpack-dev-server` for component tests. Plugins are explained in detail in the [Cypress documentation](https://docs.cypress.io/guides/tooling/plugins-guide#Installing-plugins). By default plugins are loaded from `cypress/plugins/index.js`. Create that file and add:
+The last thing we need to is tell Cypress to use `@cypress/webpack-dev-server` for component tests. Plugins are explained in detail in the [Cypress documentation](https://on.cypress.io/installing-plugins). By default plugins are loaded from `cypress/plugins/index.js`. Create that file and add:
 
 ```js
 const devServer = require("@cypress/react/plugins/react-scripts")
@@ -66,7 +66,7 @@ it('renders learn react link', () => {
 });
 ```
 
-Most tests will start with `mount` from `@cypress/react`. This is similar to `render` in Testing Library. Once you've mounted your component, you can use Cypress' extensive [query and assertion APIs](https://docs.cypress.io/api/table-of-contents) to ensure everything behaves correctly. This example asserts an anchor tag with the text "Learn React" is rendered.
+Most tests will start with `mount` from `@cypress/react`. This is similar to `render` in Testing Library. Once you've mounted your component, you can use Cypress' extensive [query and assertion APIs](https://on.cypress.io/api) to ensure everything behaves correctly. This example asserts an anchor tag with the text "Learn React" is rendered.
 
 Open the component testing runner with:
 
diff --git a/npm/vue/examples/vue-cli/README.md b/npm/vue/examples/vue-cli/README.md
@@ -22,7 +22,7 @@ We need to install:
 
 ### Configure Cypress
 
-To setup any Cypress runner, the standard way is to create a `cypress.json` file at the root of your project. Checkout [the docs](https://docs.cypress.io/guides/references/configuration) to know the extend of your options.
+To setup any Cypress runner, the standard way is to create a `cypress.json` file at the root of your project. Checkout [the docs](https://on.cypress.io/guides/configuration) to know the extend of your options.
 
 Here is the `cypress.json` file at work in this project:
 
diff --git a/packages/app/src/settings/project/Config.vue b/packages/app/src/settings/project/Config.vue
@@ -6,7 +6,7 @@
     <template #description>
       <i18n-t keypath="settingsPage.config.description">
         <ExternalLink
-          href="https://docs.cypress.io"
+          href="https://on.cypress.io/guides/configuration"
           class="text-purple-500"
         >
           cypress.config.js
diff --git a/packages/app/src/settings/project/ConfigLegend.vue b/packages/app/src/settings/project/ConfigLegend.vue
@@ -13,7 +13,7 @@
     >
       <i18n-t :keypath="legendText.config.descriptionKey">
         <ExternalLink
-          href="https://docs.cypress.io"
+          href="https://on.cypress.io/guides/configuration"
           class="text-purple-500"
         >
           cypress.config.js
@@ -41,7 +41,7 @@
     >
       <i18n-t :keypath="legendText.dynamic.descriptionKey">
         <ExternalLink
-          href="https://docs.cypress.io"
+          href="https://on.cypress.io"
           class="text-purple-500"
         >
           setupNodeEnv
diff --git a/packages/app/src/settings/project/Experiments.vue b/packages/app/src/settings/project/Experiments.vue
@@ -6,7 +6,7 @@
     <template #description>
       <i18n-t keypath="settingsPage.experiments.description">
         <ExternalLink
-          href="https://docs.cypress.io"
+          href="https://on.cypress.io/experiments"
         >
           {{ t('links.learnMore') }}
         </ExternalLink>
diff --git a/packages/app/src/settings/project/ProjectId.vue b/packages/app/src/settings/project/ProjectId.vue
@@ -9,7 +9,7 @@
     <template #description>
       <i18n-t keypath="settingsPage.projectId.description">
         <ExternalLink
-          href="https://docs.cypress.io"
+          href="https://on.cypress.io/what-is-a-project-id"
         >
           {{ t('links.learnMore') }}
         </ExternalLink>
diff --git a/packages/app/src/settings/project/RecordKey.vue b/packages/app/src/settings/project/RecordKey.vue
@@ -6,7 +6,7 @@
     <template #description>
       <i18n-t keypath="settingsPage.recordKey.description">
         <ExternalLink
-          href="https://docs.cypress.io"
+          href="https://on.cypress.io/what-is-a-record-key"
         >
           {{ t('links.learnMore') }}
         </ExternalLink>
diff --git a/packages/app/src/settings/project/SpecPatterns.vue b/packages/app/src/settings/project/SpecPatterns.vue
@@ -9,7 +9,7 @@
     <template #description>
       <i18n-t keypath="settingsPage.specPattern.description">
         <ExternalLink
-          href="https://docs.cypress.io"
+          href="https://on.cypress.io"
         >
           {{ t('links.learnMore') }}
         </ExternalLink>
diff --git a/packages/app/src/specs/generators/GeneratorSuccess.spec.tsx b/packages/app/src/specs/generators/GeneratorSuccess.spec.tsx
@@ -10,7 +10,7 @@ import { mount } from '@cypress/react'
 
 describe('<${spec.baseName} />', () => {
   it('renders', () => {
-    // https://docs.cypress.io
+    // https://on.cypress.io/mount
     mount(<${spec.baseName} />)
   })
 })
diff --git a/packages/data-context/src/sources/WizardDataSource.ts b/packages/data-context/src/sources/WizardDataSource.ts
@@ -122,7 +122,7 @@ export class WizardDataSource {
       status: 'changes',
       warningText: ['Please merge the code below with your existing',
         '<span class="px-1 inline-block rounded bg-warning-200 text-warning-600">cypress.config.js</span>'].join(' '),
-      warningLink: 'https://docs.cypress.io/config-file',
+      warningLink: 'https://on.cypress.io/guides/configuration',
     }
 
     if (testingType === 'component' && templateFileContent) {
diff --git a/packages/frontend-shared/src/components/StandardModal.vue b/packages/frontend-shared/src/components/StandardModal.vue
@@ -73,7 +73,7 @@ const props = withDefaults(defineProps<{
   clickOutside: true,
   modelValue: false,
   helpText: 'Need help?',
-  helpLink: 'https://docs.cypress.io',
+  helpLink: 'https://on.cypress.io',
   class: undefined,
   variant: undefined,
   title: '',
diff --git a/packages/frontend-shared/src/gql-components/topnav/DocsMenuContent.vue b/packages/frontend-shared/src/gql-components/topnav/DocsMenuContent.vue
@@ -91,7 +91,7 @@ const docsMenu: {
   {
     text: t('topNav.docsMenu.organizingTests'),
     link: {
-      url: 'https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests',
+      url: 'https://on.cypress.io/writing-and-organizing-tests',
       params: {
         utm_medium,
         utm_content: 'Organizing Tests',
@@ -154,7 +154,7 @@ const docsMenu: {
     text: t('topNav.docsMenu.smartOrchestration'),
     changeContent: 'orchestration',
     link: {
-      url: 'https://docs.cypress.io/guides/dashboard/smart-orchestration',
+      url: 'https://on.cypress.io/smart-orchestration',
       params: {
         utm_medium,
         utm_content: 'Smart Orchestration',
diff --git a/packages/launchpad/src/components/code/FileRow.vue b/packages/launchpad/src/components/code/FileRow.vue
@@ -93,7 +93,7 @@ const props = defineProps<{
   description?: string
 }>()
 
-const openDocs = () => window.open('https://docs.cypress.io/config')
+const openDocs = () => window.open('https://on.cypress.io/guides/configuration')
 
 // TODO: Remove this. Use FileParts when available
 const language = computed(() => {
diff --git a/packages/launchpad/src/error/BaseError.spec.tsx b/packages/launchpad/src/error/BaseError.spec.tsx
@@ -12,7 +12,7 @@ const docsLinkSelector = '[data-testid=error-docs-link]'
 const customFooterSelector = '[data-testid=custom-error-footer]'
 
 // Constants
-const docsLink = 'https://docs.cypress.io'
+const configLink = 'https://on.cypress.io/guides/configuration'
 const messages = defaultMessages.launchpadErrors.generic
 const customHeaderMessage = 'Well, this was unexpected!'
 const customMessage = `Don't worry, just click the "It's fixed now" button to try again.`
@@ -46,7 +46,7 @@ describe('<BaseError />', () => {
     .get(docsButtonSelector)
     .should('contain.text', messages.readTheDocsButton)
     .get(docsLinkSelector)
-    .should('have.attr', 'href', docsLink)
+    .should('have.attr', 'href', configLink)
   })
 
   // NOTE: Figure out how to stub the graphql mutation call
diff --git a/packages/launchpad/src/error/BaseError.vue b/packages/launchpad/src/error/BaseError.vue
@@ -27,7 +27,7 @@
           data-testid="error-message"
         >
           <ExternalLink
-            href="https://docs.cypress.io"
+            href="https://on.cypress.io/guides/configuration"
             data-testid="error-docs-link"
           >cypress.config.js</ExternalLink>
         </i18n-t>
@@ -85,7 +85,7 @@ fragment BaseError on BaseError {
 `
 
 const openDocs = () => {
-  document.location.href = 'https://docs.cypress.io'
+  document.location.href = 'https://on.cypress.io'
 }
 
 const { t } = useI18n()

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ async function injectAndShowPluginConfig<T> (template: Template<T>, {`
`84`	`84`	`code: await getPluginsSourceExample(ast),`
`85`	`85`	`language: 'js',`
`86`	`86`	`filePath: pluginsFilePath,`
`87`		`- fallbackFileMessage: 'plugins file (https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests.html#Plugin-files)',`
	`87`	`+ fallbackFileMessage: 'plugins file (https://on.cypress.io/plugins-file)',`
`88`	`88`	`})`
`89`	`89`	`}`
`90`	`90`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`<template #description>`
`7`	`7`	`<i18n-t keypath="settingsPage.config.description">`
`8`	`8`	`<ExternalLink`
`9`		`- href="https://docs.cypress.io"`
	`9`	`+ href="https://on.cypress.io/guides/configuration"`
`10`	`10`	`class="text-purple-500"`
`11`	`11`	`>`
`12`	`12`	`cypress.config.js`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`>`
`14`	`14`	`<i18n-t :keypath="legendText.config.descriptionKey">`
`15`	`15`	`<ExternalLink`
`16`		`- href="https://docs.cypress.io"`
	`16`	`+ href="https://on.cypress.io/guides/configuration"`
`17`	`17`	`class="text-purple-500"`
`18`	`18`	`>`
`19`	`19`	`cypress.config.js`
`@@ -41,7 +41,7 @@`
`41`	`41`	`>`
`42`	`42`	`<i18n-t :keypath="legendText.dynamic.descriptionKey">`
`43`	`43`	`<ExternalLink`
`44`		`- href="https://docs.cypress.io"`
	`44`	`+ href="https://on.cypress.io"`
`45`	`45`	`class="text-purple-500"`
`46`	`46`	`>`
`47`	`47`	`setupNodeEnv`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`<template #description>`
`7`	`7`	`<i18n-t keypath="settingsPage.experiments.description">`
`8`	`8`	`<ExternalLink`
`9`		`- href="https://docs.cypress.io"`
	`9`	`+ href="https://on.cypress.io/experiments"`
`10`	`10`	`>`
`11`	`11`	`{{ t('links.learnMore') }}`
`12`	`12`	`</ExternalLink>`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`<template #description>`
`10`	`10`	`<i18n-t keypath="settingsPage.projectId.description">`
`11`	`11`	`<ExternalLink`
`12`		`- href="https://docs.cypress.io"`
	`12`	`+ href="https://on.cypress.io/what-is-a-project-id"`
`13`	`13`	`>`
`14`	`14`	`{{ t('links.learnMore') }}`
`15`	`15`	`</ExternalLink>`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`<template #description>`
`7`	`7`	`<i18n-t keypath="settingsPage.recordKey.description">`
`8`	`8`	`<ExternalLink`
`9`		`- href="https://docs.cypress.io"`
	`9`	`+ href="https://on.cypress.io/what-is-a-record-key"`
`10`	`10`	`>`
`11`	`11`	`{{ t('links.learnMore') }}`
`12`	`12`	`</ExternalLink>`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ export class WizardDataSource {`
`122`	`122`	`status: 'changes',`
`123`	`123`	`warningText: ['Please merge the code below with your existing',`
`124`	`124`	`'<span class="px-1 inline-block rounded bg-warning-200 text-warning-600">cypress.config.js</span>'].join(' '),`
`125`		`- warningLink: 'https://docs.cypress.io/config-file',`
	`125`	`+ warningLink: 'https://on.cypress.io/guides/configuration',`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`if (testingType === 'component' && templateFileContent) {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`data-testid="error-message"`
`28`	`28`	`>`
`29`	`29`	`<ExternalLink`
`30`		`- href="https://docs.cypress.io"`
	`30`	`+ href="https://on.cypress.io/guides/configuration"`
`31`	`31`	`data-testid="error-docs-link"`
`32`	`32`	`>cypress.config.js</ExternalLink>`
`33`	`33`	`</i18n-t>`
`@@ -85,7 +85,7 @@ fragment BaseError on BaseError {`
`85`	`85`	`
`86`	`86`
`87`	`87`	`const openDocs = () => {`
`88`		`- document.location.href = 'https://docs.cypress.io'`
	`88`	`+ document.location.href = 'https://on.cypress.io'`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`const { t } = useI18n()`