Merge branch 'main' into query-assist-support-improved

Author: JV0812

.clabot

@@ -184,7 +184,13 @@
     "dlindelof-sumologic",
     "snyk-bot",
     "stephenthedev",
-    "Apoorvkudesia-sumologic"
+    "Apoorvkudesia-sumologic",
+    "ntanwar-sumo",
+    "aj-sumo",
+    "samiura",
+    "naveenrama",
+    "fguimond",
+    "rmeyer-legato"
   ],
   "message": "Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement and do not have yours on file. To proceed with your PR, please [sign your name here](https://forms.gle/YgLddrckeJaCdZYA6) and we will add you to our approved list of contributors.",
   "label": "cla-signed",

.github/workflows/build_and_deploy.yml

@@ -1,5 +1,8 @@
 name: Build and Deploy
 
+permissions:
+  contents: read
+
 on:
   workflow_call:
     inputs:
@@ -13,7 +16,7 @@ on:
         default: "/"
         type: string
       environment:
-        description: GHA environment name
+        description: GitHub Actions environment name (used for scoping secrets and deployment)
         required: true
         type: string
     secrets:
@@ -35,6 +38,7 @@ jobs:
     env:
       CI: true
       NODE_ENV: production
+      NODE_OPTIONS: "--max-old-space-size=8192 --max-http-header-size=8192"
       AWS_PAGER: ""
       HOSTNAME: ${{ inputs.hostname }}
       BASE_URL: ${{ inputs.base_url }}
@@ -53,16 +57,14 @@ jobs:
         uses: actions/cache@v3
         with:
           path: node_modules/.cache
-          key: ${{ runner.os }}-webpack-cache
+          key: ${{ runner.os }}-webpack-cache-${{ hashFiles('yarn.lock') }}
       - name: Install awscli
         uses: unfor19/install-aws-cli-action@v1
       - name: Install jq
         run: sudo apt-get install -y jq
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Build the Docusaurus site
-        env:
-          NODE_OPTIONS: "--max-old-space-size=8192 --max-http-header-size=8192"
         run: yarn build
       - name: Deploy the Docusaurus site
         env:

.github/workflows/delete-review.yml

@@ -1,5 +1,8 @@
 name: delete-review
 
+permissions:
+  contents: read
+
 on: delete
 
 jobs:
@@ -9,6 +12,7 @@ jobs:
       name: review/${{ github.ref_name }}
     env:
       CI: true
+      NODE_OPTIONS: "--max-old-space-size=8192 --max-http-header-size=8192"
       AWS_PAGER: ""
       BASE_URL: /${{ github.ref_name }}/
       AWS_DEFAULT_REGION: us-east-1
@@ -23,6 +27,7 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
         run: |
+          echo "Removing files at s3://${S3_BUCKET_NAME}${BASE_URL}"
           aws s3 rm --recursive s3://${S3_BUCKET_NAME}${BASE_URL}
           export INVALIDATION_ID=$(
             aws cloudfront create-invalidation \

.github/workflows/deploy-to-pantheon.yml

@@ -0,0 +1,71 @@
+name: deploy-to-pantheon
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-deploy-to-pantheon:
+    runs-on: ubuntu-latest
+    environment:
+      name: production
+      url: https://www.sumologic.com/
+    env:
+      CI: true
+      NODE_ENV: production
+      NODE_OPTIONS: "--max-old-space-size=8192 --max-http-header-size=8192"
+      HOSTNAME: https://www.sumologic.com
+      BASE_URL: /help/
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install SSH key
+        uses: shimataro/ssh-key-action@v2
+        with:
+          key: ${{ secrets.PANTHEON_SSH_KEY }}
+          config: |
+            Host *.drush.in
+               StrictHostKeyChecking no
+          known_hosts: ${{ secrets.PANTHEON_KNOWN_HOSTS }}
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.2"
+      - name: Install Terminus
+        uses: pantheon-systems/terminus-github-actions@v1
+        with:
+          pantheon-machine-token: ${{ secrets.PANTHEON_MACHINE_TOKEN }}
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+          cache: 'yarn'
+      - name: Docusaurus Webpack cache
+        uses: actions/cache@v3
+        with:
+          path: node_modules/.cache
+          key: ${{ runner.os }}-webpack-cache-${{ hashFiles('yarn.lock') }}
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build the Docusaurus site
+        run: yarn build
+      - name: Pantheon, check environment and deploy helpdocs
+        run: |
+          # Check for helpdocs environment in Pantheon, create one if not found
+          PANTHEON_ENV_LIST="$(terminus env:list "${{ vars.PANTHEON_SITE_ID }}" --format=list | xargs)"
+          DEV_SITE_EXISTS="$(echo "$PANTHEON_ENV_LIST" | grep "helpdocs" | wc -l | xargs)"
+          if [ "$DEV_SITE_EXISTS" -eq "0" ]; then
+            terminus multidev:create --no-interaction --no-ansi ${{ vars.PANTHEON_SITE_ID }}.dev helpdocs
+            terminus lock:enable ${{ vars.PANTHEON_SITE_ID }}.helpdocs -- "${{ secrets.PANTHEON_AUTH_USER }}" "${{ secrets.PANTHEON_AUTH_PASSWORD }}"
+          fi
+          # Put environment in SFTP mode, because we're using rsync to move files up
+          terminus connection:set ${{ vars.PANTHEON_SITE_ID }}.helpdocs sftp
+          terminus self:plugin:install terminus-rsync-plugin
+          mv ./build ./help          
+          terminus rsync ./help ${{ vars.PANTHEON_SITE_ID }}.helpdocs:code
+          terminus env:commit --message "Production build of helpdocs" --force -- ${{ vars.PANTHEON_SITE_ID }}.helpdocs

.github/workflows/pr.yml

@@ -1,44 +1,48 @@
 name: Pull Request Checks
 
+permissions:
+  contents: read
+  pull-requests: read
+
 on:
-    pull_request:
-      branches:
-        - main
-    merge_group:
-      types:
-        - checks_requested
+  pull_request:
+    branches:
+      - main
+  merge_group:
+    types:
+      - checks_requested
+
+env:
+  CI: true
+  NODE_ENV: production
+  NODE_OPTIONS: "--max-old-space-size=8192 --max-http-header-size=8192"
 
 jobs:
-    build-and-deploy:
-      runs-on: ubuntu-latest
-      env:
-          CI: true
-          NODE_ENV: production
-      steps:
-        - uses: actions/checkout@v4
-        - name: Set up Node.js
-          uses: actions/setup-node@v3
-          with:
-            node-version: '20.x'
-            cache: 'yarn'
-        - name: Docusaurus Webpack cache
-          uses: actions/cache@v3
-          with:
-            path: node_modules/.cache
-            key: ${{ runner.os }}-webpack-cache
-        - name: Install dependencies
-          run: yarn install --frozen-lockfile
-        - name: Build the Docusaurus site
-          env:
-            NODE_OPTIONS: "--max-old-space-size=8192 --max-http-header-size=8192"
-          run: yarn build
-    spellcheck:
-      runs-on: ubuntu-latest
-      steps:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+          cache: 'yarn'
+      - name: Docusaurus Webpack cache
+        uses: actions/cache@v3
+        with:
+          path: node_modules/.cache
+          key: ${{ runner.os }}-webpack-cache-${{ hashFiles('yarn.lock') }}
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build the Docusaurus site
+        run: yarn build
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
       - uses: actions/checkout@v4
       - uses: codespell-project/actions-codespell@master
         name: Check spelling
         with:
           skip: "*.svg,*.js,*.map,*.css,*.scss"
-          ignore_words_list: "aks,atleast,cros,ddress,fiel,ist,nd,ot,pullrequest,ser,shttp,wast,fo,seldomly,delt,cruzer,plack,secur,te,nginx,Nginx,notin"
+          ignore_words_list: "aks,atleast,cros,ddress,delink,fiel,ist,nd,ot,pullrequest,ser,shttp,wast,fo,seldomly,delt,cruzer,plack,secur,te,nginx,Nginx,notin"
           path: docs

.github/workflows/production.yml

@@ -1,5 +1,8 @@
 name: deploy-to-production
 
+permissions:
+  contents: read
+
 on:
   push:
     branches:

README.md

@@ -1,4 +1,4 @@
-<img src="https://help.sumologic.com/img/sumo-docs-readme.png" width="400"/>
+<img src="https://help.sumologic.com/img/reuse/sumo-docs-readme.png" width="400"/>
 
 <p>
   <a href="https://github.com/SumoLogic/sumologic-documentation/blob/main/.github/workflows/production.yml"><img src="https://github.com/SumoLogic/sumologic-documentation/actions/workflows/production.yml/badge.svg" alt="GitHub Actions status"></a>

blog-collector/2021/12-31.md

@@ -1,6 +1,6 @@
 ---
 title: 2021 Archive
-image: https://help.sumologic.com/img/sumo-square.png
+image: https://help.sumologic.com/img/reuse/rss-image.jpg
 ---
 
 import useBaseUrl from '@docusaurus/useBaseUrl';

blog-collector/2022/12-31.md

@@ -1,6 +1,6 @@
 ---
 title: 2022 Archive
-image: https://help.sumologic.com/img/sumo-square.png
+image: https://help.sumologic.com/img/reuse/rss-image.jpg
 ---
 
 import useBaseUrl from '@docusaurus/useBaseUrl';

blog-collector/2023/12-31.md

@@ -1,18 +1,23 @@
 ---
 title: 2023 Archive
-image: https://help.sumologic.com/img/sumo-square.png
+image: https://help.sumologic.com/img/reuse/rss-image.jpg
 ---
 
 import useBaseUrl from '@docusaurus/useBaseUrl';
 
-
-
 This is an archive of 2023 Collector Release Notes. To view the full archive, [click here](/release-notes-collector/archive).
 
 <!--truncate-->
 
 ---
-### November 13, 2023 - Version 19.467-2
+### December 18, 2023 (OpenTelemetry Collector)
+
+#### Auto Discovery
+
+We're excited to announce our new **Auto Discovery for OpenTelemetry** feature, which automatically detects the services that can be installed to monitor the data collected from the server on which the collector is running. [Learn more](/docs/send-data/opentelemetry-collector/auto-discovery).
+
+---
+### November 13, 2023 - Version 19.467-2 (Installed Collector)
 
 In this release, we've enhanced the security and stability of the Collector with added support for security patches and bug fixes.
 
@@ -30,13 +35,13 @@ In this release, we've enhanced the security and stability of the Collector with
 - Fixed temporary files issue in Windows installation.
 
 ---
-### October 26, 2023 - Version 19.461-1
+### October 26, 2023 - Version 19.461-1 (Installed Collector)
 
 In this release, we've resolved the collector start issue that was occurring after the Windows feature update. For collectors running as custom user, refer to the [Advanced UI Installer Settings](/docs/send-data/installed-collectors/collector-installation-reference/advanced-ui-installer-settings#provide-full-control-access-for-custom-user) to provide full access to custom user.
 
 
 ---
-### August 22, 2023 - Version 19.456-3
+### August 22, 2023 - Version 19.456-3 (Installed Collector)
 
 In this release, we've enhanced our Collector security and stability by adding support for security patches and bug fixes.
 
@@ -52,18 +57,18 @@ In this release, we've enhanced our Collector security and stability by adding s
 
 
 ---
-### July 11, 2023 - Version 19.451-1
+### July 11, 2023 - Version 19.451-1 (Installed Collector)
 
 * **Bug fix**. Log level for message `AppendStringInfo` is updated from info to debug.
 * **Security fix**. Upgraded `org.json:json` to version 20230227 to address known security vulnerabilities (CVE-2022-45688).
 
 ---
-### May 23, 2023 - Version 19.441-2
+### May 23, 2023 - Version 19.441-2 (Installed Collector)
 
 In this release, we've upgraded the collector JRE to **Amazon Corretto Version 8.372.07.1** to enhance reliability and stability, and optimized performance for faster execution.
 
 ---
-### May 5, 2023 - Version 19.441-1
+### May 5, 2023 - Version 19.441-1 (Installed Collector)
 
 In this release, we've enhanced the security and stability of Collector with added support for security patches and bug fixes.
 
@@ -82,13 +87,29 @@ In this release, we've enhanced the security and stability of Collector with add
 
 
 ---
-### April 20, 2023 - Version 19.418-8
+### April 20, 2023 - Version 19.418-8 (Installed Collector)
 
 We're pleased to announce that the bridge version now offers enhanced support for the BCTLS FIPS upgrade.
 
 
 ---
-### March 15, 2023 - Version 19.418-7
+### March 28, 2023 (OpenTelemetry Collector)
+
+#### Sumo Logic Distribution for OpenTelemetry
+
+New - We’re happy to announce a release that saves you configuration time. Our new and improved OpenTelemetry collector data onboarding workflow that gets you up and running with infrastructure monitoring in minutes. With this update, you can start monitoring host and process data, web servers (like IIS, Nginx), databases (like MySQL, Redis, Cassandra), and other sources out of the box - no manual configuration required. [Learn more](/docs/get-started/quickstart).
+
+The Sumo Logic Distribution for OpenTelemetry, a single unified agent to send Logs, Metrics, Traces, and Metadata, helps simplify and streamline Observability and debugging to improve overall system reliability and efficiency. [Learn more](/docs/send-data/opentelemetry-collector).
+
+:::note
+The new onboarding workflows are only available for new Trial customers at this time.
+:::
+
+<img src={useBaseUrl('img/send-data/opentelemetry-collector/otel-onboarding.gif')} alt="OpenTelemetry collector onboarding flow" />
+
+
+---
+### March 15, 2023 - Version 19.418-7 (Installed Collector)
 
 In this release, we've enhanced the security and stability of Collector with added support for security patch and bug fix.