Merge branch 'main' of github.com:cypress-io/cypress-documentation

Author: AtofStryker

.circleci/config.yml

@@ -6,35 +6,30 @@ orbs:
 executors:
   node-executor:
     docker:
-      - image: cimg/node:14.16.0
+      - image: cimg/node:16.15.1
   with-chrome-and-firefox:
     resource_class: medium+
     docker:
       - image: 'cypress/browsers:node16.13.2-chrome97-ff96'
 
 commands:
-  nuxt-build:
+  docs-build:
     steps:
       - checkout
       - restore_cache:
           keys:
-            - yarn-cache-{{ checksum "yarn.lock" }}-{{ checksum "patches/github-slugger+1.3.0.patch" }}-{{ checksum "patches/vue-scrollactive+0.9.3.patch" }}-{{ checksum "patches/@docsearch+js+1.0.0-alpha.28.patch" }}-{{ checksum "patches/@nuxt+vue-app+2.14.12.patch" }}
+            - npm-cache-{{ checksum "package-lock.json" }}            
       - run:
           name: Install Dependencies
-          command: yarn --frozen-lockfile
+          command: npm ci
       - save_cache:
-          key: yarn-cache-{{ checksum "yarn.lock" }}-{{ checksum "patches/github-slugger+1.3.0.patch" }}-{{ checksum "patches/vue-scrollactive+0.9.3.patch" }}-{{ checksum "patches/@docsearch+js+1.0.0-alpha.28.patch" }}-{{ checksum "patches/@nuxt+vue-app+2.14.12.patch" }}
+          key: npm-cache-{{ checksum "package-lock.json" }}
           paths:
             - node_modules
       - run:
-          name: Nuxt Build
-          command: yarn build
+          name: Docs Build
+          command: npm run build
 
-  link-check-changed-files:
-    steps:
-      - run:
-          name: Broken link checker for changed files
-          command: yarn changed-files-broken-link-checker:ci
 
 job-defaults: &job-defaults
   executor: node-executor
@@ -44,145 +39,51 @@ jobs:
   build:
     <<: *job-defaults
     steps:
-      - nuxt-build
+      - docs-build
       - persist_to_workspace:
           root: ~/repo
           paths:
-            - build/*
+            - dist/*
             - node_modules/*
 
-  link-check-changed-files:
-    <<: *job-defaults
-    steps:
-      - checkout
-      - attach_workspace:
-          at: ~/repo
-      - link-check-changed-files
-
   lint:
     <<: *job-defaults
     steps:
       - checkout
       - attach_workspace:
           at: ~/repo
-      - run: yarn lint
-
-  broken-link-check-prod:
-    <<: *job-defaults
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - yarn-cache-{{ checksum "yarn.lock" }}-{{ checksum "patches/github-slugger+1.3.0.patch" }}-{{ checksum "patches/vue-scrollactive+0.9.3.patch" }}-{{ checksum "patches/@docsearch+js+1.0.0-alpha.28.patch" }}-{{ checksum "patches/@nuxt+vue-app+2.14.12.patch" }}
-      - run:
-          name: Install Dependencies
-          command: yarn --frozen-lockfile
-      - run:
-          name: Broken link checker
-          command: yarn broken-link-checker:prod
-
+      - run: npm run lint
+  
   release:
-    <<: *job-defaults
-    steps:
-      - nuxt-build
-      - run:
-          name: Docsearch Scraper
-          command: node ./cy_scripts/scrape.js
-
-  publish-scheduled-sanity-content:
     <<: *job-defaults
     steps:
       - checkout
-      - restore_cache:
-          keys:
-            - yarn-cache-{{ checksum "yarn.lock" }}-{{ checksum "patches/github-slugger+1.3.0.patch" }}-{{ checksum "patches/vue-scrollactive+0.9.3.patch" }}-{{ checksum "patches/@docsearch+js+1.0.0-alpha.28.patch" }}-{{ checksum "patches/@nuxt+vue-app+2.14.12.patch" }}
-      - run:
-          name: Install Dependencies
-          command: yarn --frozen-lockfile
+      - attach_workspace:
+          at: ~/repo
+      - setup_remote_docker
       - run:
-          name: Check for scheduled sanity.io content to publish and invoke Netlify build hook if necessary
-          command: node ./scripts/sanity/publishContent.js
+          name: Algolia Scraper
+          command: |
+            echo "Scraping..."
+            ls
+            node ./scripts/search/scrape-and-compare-algolia-index.mjs 
 
 workflows:
   version: 2
   build-and-test:
     jobs:
-      - cypress/install:
-          name: 'Setup Linux'
-          yarn: true
-          install-command: yarn --frozen-lockfile
-          executor: with-chrome-and-firefox
-          post-steps:
-            - run:
-                name: 'Unit tests'
-                command: yarn test:unit --ci --runInBand
-
-      - link-check-changed-files:
-          name: 'Broken link checker'
-          requires:
-            - build
-
+      - build
       - lint:
           name: "Lint JS/CSS/Markdown"
           requires:
-            - build
+            - build     
 
-      # Run E2E tests in Chrome
-      - cypress/run:
-          name: 'UI Tests - Chrome'
-          browser: chrome
-          spec: cypress/integration/*
-          executor: with-chrome-and-firefox
-          wait-on: 'http://localhost:3000'
-          command-prefix: npx percy exec --
-          yarn: true
-          start: yarn start:ci
-          parallel: true
-          parallelism: 4
-          ci-build-id: ${CIRCLE_SHA1:0:8}
-          group: 'UI - Chrome'
+      # Run Algolia scraper only on main.
+      - release:
+          name: 'Run Algolia scraper'
           requires:
             - build
-            - Setup Linux
-          command: |
-            if [ -n "$DOCS_RECORD_KEY" ]; then
-              yarn cypress run --record --key $DOCS_RECORD_KEY --parallel
-            else
-              yarn cypress run
-            fi
-
-      - build:
-          filters:
-            branches:
-              ignore:
-                - master
-
-      # Run docsearch-scraper only on master.
-      - release:
-          name: 'Run docsearch scraper'
-          filters:
-            branches:
-              only:
-                - master
-
-  nightly:
-    triggers:
-      - schedule:
-          cron: "0 0 * * *"
           filters:
             branches:
               only:
-                - master
-    jobs:
-      - broken-link-check-prod
-
-  sanity-scheduled-content-check:
-    triggers:
-      - schedule:
-          cron: "0 0,12 * * *"
-          filters:
-            branches:
-              only:
-                - master
-    jobs:
-      - publish-scheduled-sanity-content
+                - main

.eslintignore

@@ -0,0 +1,9 @@
+
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Chat
+    url: https://on.cypress.io/discord
+    about: Want to discuss Cypress with others? Check out our chat.
+  - name: Cypress App or Cloud Issue
+    url: https://github.com/cypress-io/cypress/issues/new
+    about: This issue tracker is not for App or Cloud issues. Please open issues related to the App or Cloud here.

.eslintrc-textlint

@@ -8,6 +8,6 @@ Before submitting your plugin, please check to see if it fulfills these requirem
 - [ ] 🛠 Plugin purpose is clearly documented (in a README or docs website)
 - [ ] 📝 Well-written documentation - A great example ([link](https://github.com/Fredx87/cypress-keycloak-commands#cypress-keycloak-commands))
 - [ ] 🔬 Tested using Cypress - tests using Cypress can act as both example usage _and_ test coverage
-- [ ] 👷‍♀️ CI pipeline that's passing (CircleCI and [Github Actions](https://github.com/cypress-io/cypress-tutorial-build-todo/blob/master/.github/workflows) are both free for Open Source)
+- [ ] 👷‍♀️ CI pipeline that's passing (CircleCI and [Github Actions](https://github.com/cypress-io/cypress-tutorial-build-todo/blob/main/.github/workflows) are both free for Open Source)
 
 If you have reason to believe your plugin does not need to meet certain requirements, please feel free to provide justification below:

.eslintrc.js

@@ -1,4 +1,4 @@
-name: Create PR - develop -> master
+name: Create PR - develop -> main
 
 # run this workflow only
 # when a pull request to "develop" branch is closed
@@ -19,15 +19,15 @@ jobs:
 
       # https://github.com/repo-sync/pull-request
       # if the pull request has been successfully merged, then create
-      # a PR to "master" branch
+      # a PR to "main" branch
       - name: pull-request
         uses: repo-sync/pull-request@v2
         if: github.event.pull_request.merged == true
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # be explicit about branches
           source_branch: "develop"
-          destination_branch: "master"
-          pr_title: "develop to master auto PR"
-          pr_body: ":robot: Automated PR from **develop** to **master**"
+          destination_branch: "main"
+          pr_title: "develop to main auto PR"
+          pr_body: ":robot: Automated PR from **develop** to **main**"
           pr_label: "auto-pr"

.github/ISSUE_TEMPLATE/config.yml

@@ -1,23 +1,36 @@
-node_modules/
-db.json
-public/
-*.log
-.history
-.vscode
+# Dependencies
+node_modules
+
+# Production
+build
+dist
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
 .DS_Store
-.deploy*/
-support
-!cypress/support
-.idea/
-.nuxt/
-dist/
-static/sw.js
-.eslintcache
-.circle-credentials.json
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
 
-themes/cypress/source/css/vendor/
-themes/cypress/source/js/vendor/
-themes/cypress/source/fonts/vendor/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
 
+.vscode
 cypress/screenshots
 cypress/videos
+
+# Generated files
+.docusaurus
+.cache-loader
+
+.nuxt
+.husky
+themes
+.eslintcache
+db.json