Merge branch 'main' into generate-redirects

Author: rosieyohannan

.circleci/config.yml

@@ -6,7 +6,8 @@ parameters:
     default: ""
 
 orbs:
-  aws-cli: circleci/[email protected] 
+  aws-cli: circleci/[email protected]
+  vale: circleci/[email protected]
 
 executors:
   node_executor:
@@ -63,9 +64,9 @@ jobs:
     steps:
       - checkout
       - run:
-          name: Fetch branches matching server-v*
+          name: Fetch branches matching server-4*
           command: |
-            for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-v' | sed 's|refs/heads/||'); do
+            for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-4' | sed 's|refs/heads/||'); do
               echo "[INFO] Fetching branch: $branch"
               git checkout "$branch"
               git pull origin "$branch"
@@ -108,7 +109,6 @@ jobs:
       - notify_error:
           message: "Build job failed for branch ${CIRCLE_BRANCH}"
 
-
   validate:
     executor: ruby_executor
     steps:
@@ -129,7 +129,6 @@ jobs:
       - notify_error:
           message: "Validation job failed for branch ${CIRCLE_BRANCH}"
 
-
   deploy-preview:
     executor: node_executor
     steps:
@@ -184,19 +183,29 @@ jobs:
       - notify_error:
           message: "Deploy preview job failed for branch ${CIRCLE_BRANCH}"
 
-
   deploy-production:
     executor: node_executor
+    parameters:
+      bucket_name:
+        description: The name of the s3 bucket where static assets are stored.
+        type: string
+      build_dir:
+        default: "build"
+        description: The path to the docs build directory
+        type: string
     steps:
       - attach_workspace:
           at: .
       - aws-setup
       - run:
           name: Deploy Production Site to S3
           command: |
+            AWS_S3_BUCKET=<< parameters.bucket_name >>
+            BUILD_DIRECTORY=<< parameters.build_dir >>
+
             set -e
             echo "[INFO] Deploying production site..."
-            aws s3 sync build s3://${DOCS_BUILD_BUCKET}/ --delete --endpoint-url ${S3_ENDPOINT}
+            aws s3 sync "$BUILD_DIRECTORY" "s3://$AWS_S3_BUCKET/"
       - notify_error:
           message: "Production deployment job failed for branch ${CIRCLE_BRANCH}"
 
@@ -241,27 +250,48 @@ jobs:
               echo "[WARN] Tag '${TAG}' not found."
             fi
 
-
 workflows:
+  lint:
+    unless:
+      equal: [main, << pipeline.git.branch >>]
+    jobs:
+      - vale/lint:
+          reference_branch: main
+          base_dir: docs
   build_validate_and_deploy:
     when:
       equal: ["", << pipeline.parameters.cleanup_preview_branch >>]
     jobs:
-      - build
+      - build:
+          context: circleci-docs-static
       - validate:
           requires: [build]
       - deploy-preview:
           requires: [validate]
           filters:
             branches:
               ignore: main
-          context: circleci-docs-static
+          context:
+            [
+              circleci-docs-static,
+              docs-platform-assets,
+              web-ui-npm,
+              web-ui-datadog,
+            ]
       - deploy-production:
           requires: [validate]
           filters:
             branches:
               only: main
-          context: circleci-docs-static
+          context:
+            [
+              circleci-docs-static,
+              docs-platform-assets,
+              web-ui-npm,
+              web-ui-datadog,
+            ]
+          bucket_name: "circleci-docs-platform-assets/docs-preview"
+          build_dir: "build"
   cleanup_preview:
     when: pipeline.parameters.cleanup_preview_branch != ""
     jobs:

.env.copy

@@ -1,5 +1,6 @@
 ALGOLIA_APP_ID=
 ALGOLIA_ADMIN_KEY=
 ALGOLIA_INDEX_NAME=circleci-docs
+COOKIEBOT=
 SEGMENT_WRITE_KEY=
 SKIP_INDEX_SEARCH=true

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+* @circleci/docs @circleci/docs-friends @circleci/lifecycle @circleci/product-mgmt-product-experience
+

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,15 @@
+---
+name: Bug
+about: A technical problem
+---
+
+# Description
+Describe the bug you found.
+
+# Location
+Describe where you caught the bug.
+If the bug occurs in a specific document,
+add the link here.
+
+# Steps to Reproduce
+Describe the steps you took to produce the bug.

.github/ISSUE_TEMPLATE/grammatical_error.md

@@ -0,0 +1,10 @@
+---
+name: Grammatical Error
+about: Grammatically incorrect writing
+---
+
+# Location
+A link to the document with the error.
+
+# Error Details
+A brief description of the error.

.github/ISSUE_TEMPLATE/inconsistent.md

@@ -0,0 +1,11 @@
+---
+name: Inconsistent
+about: Conflicting information
+---
+
+# Locations
+Add a link to the document (or documents)
+with the conflicting documentation.
+
+# Conflict Description
+Describe the conflicting documentation.

.github/ISSUE_TEMPLATE/incorrect.md

@@ -0,0 +1,13 @@
+---
+name: Incorrect
+about: Incorrect information
+---
+
+# Locations
+Add a link to the document
+with the incorrect information.
+
+# Details
+Describe the incorrect information in the document.
+Extra evidence like build output or other links
+is helpful in "proving" that documentation isn't correct.

.github/ISSUE_TEMPLATE/typo.md

@@ -0,0 +1,10 @@
+---
+name: Typo
+about: A typographical error
+---
+
+# Location
+A link to the document with the typo.
+
+# Error Details
+A description of the typo.

.github/ISSUE_TEMPLATE/unclear.md

@@ -0,0 +1,11 @@
+---
+name: Unclear
+about: Confusing language
+---
+
+# Location
+A link to the document that is unclear.
+
+# Explanation
+Describe what confused you about the document.
+This could be syntax, word choice, sentence length, or something entirely different.

.github/ISSUE_TEMPLATE/undocumented.md

@@ -0,0 +1,16 @@
+---
+name: Undocumented
+about: Missing information
+---
+
+# Missing Information
+Give a brief overview of the information you were looking for.
+
+# Already Looked
+Provide a list of places you've already looked for this information.
+Links are much appreciated.
+
+# Potential Locations
+Tell us where you would expect to find this information.
+This can be either an existing document,
+or an entirely new document.