[pull] master from circleci:master

.circleci/config.yml

@@ -1,13 +1,22 @@
 version: 2.1 # Set the CI version.
 
-
 # We use orbs to provide some common ruby and node tasks and shorten our config.
 # Learn more about orbs: https://circleci.com/orbs/
 orbs:
-  ruby: circleci/ruby@0.1.2
-  node: circleci/node@1.1.6
-  md-proofer: hubci/md-proofer@0.1
+  ruby: circleci/ruby@2.5.2
+  node: circleci/node@7.1.0
+  md-proofer: hubci/md-proofer@0.1.1
+  vale: circleci/vale@1.2.0
 
+# This is using the new Scheduled Pipeline feature.
+# Right now (10/2021) there is no UI to configure it, so if you need to
+# change it's behavior, you'll have to do it manualy:
+# https://circleci.atlassian.net/wiki/spaces/CD/pages/6301483319/Schedule+Pipelines+Migration#Other-methods
+# See the "GET", "DELETE" or "PATCH" section.
+parameters:
+  run-schedule:
+    type: boolean
+    default: false
 
 # Yaml References enable us to DRY out our config by sharing variables across multiple jobs.
 # In this case, we are commonly using the "workspaces" feature to share
@@ -26,12 +35,6 @@ references:
 # In this case, whenever you see `- ruby-deps` as a "step" in the config below,
 # It is executing a command to restore_cache, install deps if needed, and save_cache.
 commands:
-  install-shared-assets:
-     description: "Updates the shared-code between outer and docs."
-     steps:
-       - run:
-           name: update submodules
-           command: git submodule update --init src-shared
   ruby-deps:
     description: "Runs specialized Ruby cache steps."
     parameters:
@@ -51,6 +54,8 @@ commands:
             if [[ "<< parameters.dir >>" != "" ]]; then
               cd << parameters.dir >>
             fi
+            #cmake is needed fo rugged, a gem dependency
+            sudo apt-get update && sudo apt-get install -y cmake
             bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
       - save_cache:
           key: circleci-docs-v1-{{ .Branch }}-<< parameters.dir >>-{{ checksum "Gemfile.lock" }}
@@ -63,117 +68,91 @@ commands:
       - run:
           name: Populate JEKYLL_BASENAME env var
           command: |
-            if [ ${CIRCLE_BRANCH} = master -o ${CIRCLE_BRANCH} = main ]; then
+            if [ ${CIRCLE_BRANCH} = master -o ${CIRCLE_BRANCH} = main -o ${CIRCLE_BRANCH} = /.*-preview/ ]; then
               echo "export JEKYLL_BASENAME=docs" >> $BASH_ENV;
             else
               echo "export JEKYLL_BASENAME=${CIRCLE_BRANCH}" >> $BASH_ENV;
             fi
 
+  trigger-docs-platform-build:
+    description: Call API V2 to deploy content to Docs Platform
+    steps:
+      - run:
+          name: Deploy content to Docs Platform
+          command: |
+            curl --request POST \
+            --url https://circleci.com/api/v2/project/gh/circleci/docs-platform/pipeline \
+            --header "Circle-Token: $CIRCLECI_API_KEY" \
+            --header 'content-type: application/json' \
+            --data '{"branch": "main"}'
+
+  trigger-docs-platform-preview-build:
+    description: Call API V2 to deploy content to Docs Platform Preview
+    steps:
+      - run:
+          name: Deploy content to Docs Platform Preview
+          command: |
+            curl --request POST \
+            --url https://circleci.com/api/v2/project/gh/circleci/docs-platform/pipeline \
+            --header "Circle-Token: $CIRCLECI_API_KEY" \
+            --header 'content-type: application/json' \
+            --data '{"branch": "preview"}'
+
 # Workflows orchestrate a set of jobs to be run;
 # the jobs for this pipeline are # configured below
 workflows:
 
+  lint:
+    unless:
+      or:
+        - equal: [ master, << pipeline.git.branch >> ]
+        - equal: [ preview, << pipeline.git.branch >> ]
+        - << pipeline.parameters.run-schedule >>
+    jobs:
+      - vale/lint:
+          reference_branch: master
+
   build-deploy:
+    when:
+      not: << pipeline.parameters.run-schedule >>
     jobs:
-      - js_build
-      - build_server_pdfs:
-          filters:
-            branches:
-              only: /server\/.*/
       - build_api_docs
       - build:
           requires:
-            - js_build
-            - build_server_pdfs
             - build_api_docs
       - reindex-search:
-          requires:
-            - build
           filters:
             branches:
               only: master
-      - deploy-preview:
+      - deploy:
           requires:
             - build
           filters:
             branches:
-              only: /.*-preview/
-      - deploy:
+              only: master
+      - deploy-preview:
           requires:
             - build
           filters:
             branches:
-              only: master
-  # We run a nightly build for running build/maintenance tasks
-  # such as pulling in docker image tags or automating our api documentation
+              only: preview
+
+
+  # We run a nightly build to refresh content and build docs-platform
+  # at least once every day. Triggered every day at 08:00 AM on master branch
   nightly-build:
-    triggers:
-      - schedule:
-          cron: "0 8 * * *"
-          filters:
-            branches:
-              only: master
+    when: << pipeline.parameters.run-schedule >>
     jobs:
-      - js_build
-      - build_api_docs
-      - build:
-          requires:
-            - js_build
-            - build_api_docs
-      - deploy:
-          requires:
-            - build
-
+      - trigger-deploy
 
 jobs:
-  js_build: # this job is responsible for building Javascript assets and making them available for the "build" job
-    executor: # we specify our executor to use the node orb.
-      name: node/default
-      tag: '8.11.1'
-    steps:
-      - *attach_workspace
-      - checkout # get the code from GitHub
-      - install-shared-assets
-      - node/with-cache: # An orb command for steps to run in-between restoring and saving a cache.
-          cache-key: "package-lock.json"
-          cache-version: v9
-          steps:
-            - run: npm install
-      - run:
-          name: "Prepare JS assets" # Compile our final, production-ready JavaScript.
-          command: npm run webpack-prod
-      - run:
-          name: "Persist JS assets" # Move our JS into our workspace.
-          command: |
-            set -exu
-            mkdir -p /tmp/workspace/js
-            mv jekyll/assets/js/*.bundle.js /tmp/workspace/js/
-      - persist_to_workspace: # store the built files into the workspace for other jobs.
-          root: *workspace_root
-          paths:
-            - js
 
-
-
-  build_server_pdfs: # this job builds server-related pdf documentation, persisting it to the workspace as well.
-    docker:
-      - image: asciidoctor/docker-asciidoctor
-    steps:
-      - *attach_workspace
-      - checkout
-      - run:
-          name: Build PDFs for Server
-          command: ./scripts/build_pdfs_asciidoc.sh
-      - store_artifacts:
-          path: release/tmp/
-
-  build_api_docs: # a job to manage building our api documentation and persisting it to the workspace
+  build_api_docs: # a job to manage building our api documentation and persisting it to the workspace.
     executor:
       name: ruby/default
-      tag: '2.6.3-node-browsers'
+      tag: '3.1.3-browsers'
     steps:
       - checkout
-      - install-shared-assets
       - *attach_workspace
       - run:
           name: "Create landing folder for API doc output"
@@ -183,47 +162,43 @@ jobs:
       - ruby-deps:
           dir: src-api
       - restore_cache:
-          key: circleci-docs-v2-{{ .Branch }}-{{ checksum "src-api/package-lock.json"}}
+          key: circleci-docs-v2-{{ .Branch }}-{{ checksum "src-api/yarn.lock"}}
       - run:
           name: Install Node dependencies
-          command: cd src-api; npm install
+          command: cd src-api; yarn install
       - save_cache:
-          key: circleci-docs-v2-{{ .Branch }}-{{ checksum "src-api/package-lock.json"}}
+          key: circleci-docs-v2-{{ .Branch }}-{{ checksum "src-api/yarn.lock"}}
           paths:
             - src-api/node_modules
       - run:
           name: Build API 1.x documentation with Slate
           command: ./scripts/build_api_docs.sh -v1
       - run:
-          name: Build API 2.x documentation with Widdershins and Slate
+          name: Build API 2.x documentation with Redocly
           command: ./scripts/build_api_docs.sh -v2
       - persist_to_workspace:
           root: *workspace_root
           paths:
             - api
 
-  # The Main "Build" job. It pulls in assets from previous jobs (the built api docs, pdfs and javascript)
+  # The Main "Build" job. It pulls in assets from previous jobs (the built api docs, and javascript)
   # and puts everything in its place for a Jekyll build.
   build:
     executor:
       name: ruby/default
-      tag: '2.6.3-node-browsers'
+      tag: '3.1.3-browsers'
     resource_class: medium+
     working_directory: ~/circleci-docs
     environment:
       JEKYLL_ENV: production
-      NOKOGIRI_USE_SYSTEM_LIBRARIES: true
       JOB_RESULTS_PATH: run-results
     steps:
       - checkout
-      - install-shared-assets
       - *attach_workspace
-      - md-proofer/install:
-          version: "0.3.0"
-      - run:
-          name: "Test Markdown Files"
-          command: md-proofer lint jekyll/_cci2/ jekyll/_api/ jekyll/_cci1/
       - ruby-deps
+      - node/install-packages:
+          pkg-manager: yarn
+          cache-version: &npm-cache-version # Gets cache version from project environment variable (E.g v1)
       - run:
           name: Create results directory
           command: mkdir -p $JOB_RESULTS_PATH
@@ -234,18 +209,12 @@ jobs:
           name: Restore Previous Job Assets (Javascript, API docs) to Jekyll directory.
           command: |
             set -exu
-            mkdir -p /tmp/workspace/js
-            mv /tmp/workspace/js/* jekyll/assets/js/
             mkdir -p /tmp/workspace/api
             cp -r /tmp/workspace/api/ jekyll/_api/
             # remove unusued /api folder.
             rm -rf jekyll/_api/api
-            mkdir -p /tmp/workspace/pdfs
             cp -r /tmp/workspace/api/* jekyll/_api/
-      - run: sudo apt-get update; sudo apt-get --yes install nkf
-      - run:
-          name: Shim untranslated Japanese pages
-          command: ./scripts/shim-translation.sh jekyll/_cci2 jekyll/_cci2_ja
+      - run: sudo apt-get --yes install nkf
       - set-jekyll-basename
       - run:
           name: Build the Jekyll site
@@ -280,13 +249,12 @@ jobs:
   reindex-search:
     executor:
       name: ruby/default
-      tag: '2.6.3-node-browsers'
+      tag: '3.1.3-browsers'
     working_directory: ~/circleci-docs
     environment:
       JEKYLL_ENV: production
     steps:
       - checkout
-      - install-shared-assets
       - *attach_workspace
       - restore_cache:
           key: circleci-docs-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
@@ -295,27 +263,27 @@ jobs:
           name: Update Algolia Index
           command: |
             ALGOLIA_API_KEY=$ALGOLIA_PRIVATE_KEY bundle exec jekyll algolia --source jekyll --config jekyll/_config.yml
+
   deploy:
     docker:
-      - image: cibuilds/aws:1.16.185
+      - image: cibuilds/aws:2.8.13
     steps:
       - attach_workspace:
           at: ./generated-site
       - set-jekyll-basename
-      - run:
-          name: Deploy to S3 if tests pass and branch is Master
-          command: aws s3 sync generated-site/_site/${JEKYLL_BASENAME} s3://circle-production-static-site/${JEKYLL_BASENAME}/ --delete
+      - trigger-docs-platform-build
 
   deploy-preview:
     docker:
-      - image: cibuilds/aws:1.16.185
+      - image: cibuilds/aws:2.8.13
     steps:
       - attach_workspace:
           at: ./generated-site
       - set-jekyll-basename
-      - run:
-          name: Deploy preview version
-          command: aws s3 sync generated-site/_site/${JEKYLL_BASENAME} s3://circleci-doc-preview/${JEKYLL_BASENAME}/ --delete
-      - run:
-          name: Preview deployment URL
-          command: echo "Preview is deployed at http://circleci-doc-preview.s3-website-us-east-1.amazonaws.com/${JEKYLL_BASENAME}"
+      - trigger-docs-platform-preview-build
+
+  trigger-deploy:
+    docker:
+      - image: cibuilds/aws:2.8.13
+    steps:
+      - trigger-docs-platform-build

.git-blame-ignore-revs

@@ -0,0 +1,8 @@
+# @nramabad - Lint: src-api javascript files 
+fa807b5b394fb5e388d0dac1dd9c1ba7d4d6f22a
+
+# @nramabad - Lint: src-js javascript files
+1c8dd5949ba068cf8e4580df84a548ac86842355
+
+# @nramabad - Lint: webpack file
+61f250bc3ad4b2e6e57f33a1f717c571112c41a8

.github/CODEOWNERS

@@ -0,0 +1,11 @@
+* @circleci/docs @circleci/docs-friends @circleci/lifecycle @circleci/product-mgmt-product-experience
+
+# removed owners to allow Renovate auto-merge
+Gemfile
+src-api/Gemfile
+.circleci/config.yml
+docker-compose-yml
+Dockerfile
+package.json
+src-api/package.json
+.ruby-version

.github/pull_request_template.md

@@ -3,4 +3,17 @@ A brief description of the changes.
 
 # Reasons
 A link to a GitHub and/or JIRA issue (if applicable).
-Otherwise, a brief sentence about why you made these changes.
+Otherwise, a brief sentence about why you made these changes.
+
+# Content Checklist
+Please follow our style when contributing to CircleCI docs. Our style guide is here: [https://circleci.com/docs/style/style-guide-overview](https://circleci.com/docs/style/style-guide-overview).
+
+Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:
+
+- [ ] Break up walls of text by adding paragraph breaks.
+- [ ] Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
+- [ ] Keep the title between 20 and 70 characters.
+- [ ] Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
+- [ ] Check all headings h1-h6 are in sentence case (only first letter is capitalized).
+- [ ] Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
+- [ ] Include relevant backlinks to other CircleCI docs/pages.