Merge branch 'develop' into keycloak-commands

.node-version

@@ -1 +1 @@
-8.6.0
+8.16.0

.textlintrc

@@ -15,6 +15,7 @@
         ["test runner", "Test Runner"],
 
         // Brands and Technologies
+        ["ansi", "ANSI"],
         "AppVeyor",
         "Babel",
         ["^Blob(?! %)", "Blob"],

CONTRIBUTING.md

@@ -12,6 +12,7 @@ Thanks for taking the time to contribute! :smile:
   - [Adding Plugins](#adding-plugins)
   - [Adding Pages](#adding-pages)
   - [Writing the Changelog](#writing-the-changelog)
+  - [Translating](#translating)
 - [Committing Code](#committing-code)
   - [Linting](#linting)
   - [Pull Requests](#pull-requests)
@@ -103,9 +104,19 @@ To add a page such as a new guide or API documentation:
 - Link to your new page in the [`sidebar.yml`](/source/_data/sidebar.yml).
 - Add translations for the sidebar link for each supported language (for English, this is located in [`en.yml`](/themes/cypress/languages/en.yml)).
 - Build the documentation site locally so that you can visually inspect your new page and the links to it.
-- Commit the new file using git - we auto-generate the doc to display within each supported language, this auto-generation depends on the file existing in git.
+- **REQUIRED**: Commit the new file using git - we auto-generate the doc to display within each supported language, this auto-generation depends on the file existing in git.
 - Submit a [pull request](#Pull-Requests) for your change.
 
+### Deleting Pages
+
+To delete a page:
+
+- Delete the page from the relevant directory under [`source`](/source).
+- Remove the link from the the [`sidebar.yml`](/source/_data/sidebar.yml).
+- Remove the translations for the sidebar link for each supported language (for English, this is located in [`en.yml`](/themes/cypress/languages/en.yml)).
+- **REQUIRED**: Commit the change using git - we auto-remove the doc within each supported language, this auto-generation depends on the file being deleted in git, the build will not work until this is commited.
+- Build the documentation site locally so that you can visually inspect and make sure it was properly deleted.
+
 #### A Worked Example
 
 Let's imagine that the Cypress team has just added a new command called `privateState` and you've picked up the task to document it.

circle.yml

@@ -137,6 +137,9 @@ jobs:
           path: cypress/screenshots
       - store_artifacts:
           path: npm-debug.log
+      # store NPM logs in case there was a problem
+      - store_artifacts:
+          path: ~/.npm/_logs
 
   "deploy-docs-production":
     <<: *defaults
@@ -150,6 +153,11 @@ jobs:
       # use script that just deploys without rebuilding the production docs
       - run: npm run deploy-prebuilt -- --environment production --scrape
       - run: cat public/build.json
+      - store_artifacts:
+          path: npm-debug.log
+      # store NPM logs in case there was a problem
+      - store_artifacts:
+          path: ~/.npm/_logs
 
 workflows:
   version: 2

cy_scripts/deploy.js

@@ -88,7 +88,8 @@ function deployEnvironmentBranch (env, branch) {
   checkBranchEnvFolder(branch)(env)
 
   debug('uploading to S3 dist folder %s', distDir)
-  uploadToS3(distDir, env)
+
+  return uploadToS3(distDir, env)
   .then(() => scrapeDocs(env, branch))
   .then(() => {
     console.log(chalk.yellow('\n==============================\n'))

cy_scripts/scrape.js

@@ -33,6 +33,14 @@ function checkToken (token) {
 }
 
 function getCircleCredentials () {
+  // the JSON file should have an object like
+  // { "token": "abc123..." }
+  // where the token is your personal API token from CircleCI
+  // alternatively, put the JSON object into environment variable
+  // with file shown by filenameToShellVariable(jsonFile) call
+  // which is something like _circle_credentials_json
+  // you can load such environment variable quickly from local terminal with
+  // https://github.com/bahmutov/as-a
   const jsonFile = path.join('support', '.circle-credentials.json')
   const config = configFromEnvOrJsonFile(jsonFile)
 

cypress/integration/i18n_spec.js

@@ -7,6 +7,30 @@ describe('i18n', () => {
     cy.url().should('contain', 'why-cypress')
   })
 
+  context('alternate links', () => {
+    it('provides an alternate link for available English languages', function () {
+      cy.wrap(this.langValues).each((lang) => {
+        cy.get(`link[hreflang="${lang}"]`).should(($linkTag) => {
+          let expectedPath = `${lang}/guides/overview/why-cypress.html`
+
+          if (lang === 'en') {
+            expectedPath = 'guides/overview/why-cypress.html'
+          }
+
+          expect($linkTag[0].rel).to.eq('alternate')
+          expect($linkTag[0].href).to.include(expectedPath)
+        })
+      })
+    })
+
+    it('provides a default', function () {
+      cy.get('link[hreflang="x-default"]').should(($linkTag) => {
+        expect($linkTag[0].rel).to.eq('alternate')
+        expect($linkTag[0].href).to.include('guides/overview/why-cypress.html')
+      })
+    })
+  })
+
   context('language select', () => {
     it('selects English by default', () => {
       cy.get('#lang-select').find('option')

cypress/integration/main_spec.js

@@ -9,18 +9,6 @@ describe('Main', () => {
     cy.server()
   })
 
-  context('robots.txt', () => {
-    if (!Cypress.isDevelopment()) {
-      it('has robots.txt', () => {
-        cy.request('/robots.txt').its('body')
-        .should('include', 'Disallow: /ja/')
-        .and('include', 'Disallow: /zh-cn/')
-        .and('include', 'Disallow: /pt-br/')
-        .and('include', 'Disallow: /ru/')
-      })
-    }
-  })
-
   context('CSS', () => {
     beforeEach(() => {
       cy.visit('/')