From 111199bfbde919cd16dd32a235185647f6fd1593 Mon Sep 17 00:00:00 2001
From: Shiyuan Zhao <shiyuan.zhao@laserfiche.com>
Date: Fri, 27 Oct 2023 09:29:14 -0700
Subject: [PATCH] update yml copyright comments

---
 .github/workflows/jekyll_gh_pages.yml         | 119 +++++++--------
 .github/workflows/main.yml                    | 119 +++++++--------
 .github/workflows/veracode_build.yml          | 107 +++++++-------
 jekyll_files/_config.yml                      | 135 +++++++++---------
 jekyll_files/_includes/js/custom.js           |   2 +
 jekyll_files/_includes/lunr/custom-index.js   |   3 +
 jekyll_files/_includes/nav_footer_custom.html |   3 +
 7 files changed, 254 insertions(+), 234 deletions(-)

diff --git a/.github/workflows/jekyll_gh_pages.yml b/.github/workflows/jekyll_gh_pages.yml
index 6bd9014..78df56f 100644
--- a/.github/workflows/jekyll_gh_pages.yml
+++ b/.github/workflows/jekyll_gh_pages.yml
@@ -1,58 +1,61 @@
-# Sample workflow for building and deploying a Jekyll site to GitHub Pages
-name: Deploy SharePoint Integration Documentation
-
-on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ['1.x']
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: 'pages'
-  cancel-in-progress: false
-
-jobs:
-  # Build job
-  build:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-
-      - name: Move LaserficheSharePointIntegrationAppManifest.json
-        run: cp ./UserDocuments/LaserficheSharePointIntegrationAppManifest.json ./jekyll_files/docs/assets/LaserficheSharePointIntegrationAppManifest.json
-
-      - name: Build with Jekyll
-        uses: actions/jekyll-build-pages@v1
-        with:
-          source: ./jekyll_files
-          destination: ./_site
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-
-  # Deployment job
-  deploy:
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2
+# Copyright (c) Laserfiche.
+# Licensed under the MIT License. See LICENSE in the project root for license information.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy SharePoint Integration Documentation
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ['1.x']
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Move LaserficheSharePointIntegrationAppManifest.json
+        run: cp ./UserDocuments/LaserficheSharePointIntegrationAppManifest.json ./jekyll_files/docs/assets/LaserficheSharePointIntegrationAppManifest.json
+
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./jekyll_files
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+
+  # Deployment job
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index f4c1255..837e5c0 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -1,58 +1,61 @@
-name: SPFx CI CD
-
-on:
-  push:
-    branches: ['\d+.x']
-  pull_request:
-    branches: ['\d+.x']
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-env:
-  packagePath: sharepoint/solution/LaserficheSharePointOnlineIntegration.sppkg
-  packagePathUserDocs: UserDocuments
-  fullVersion: 1.0.0.${{github.run_number}}
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16.x
-
-      - name: Tag commit
-        uses: rickstaa/action-create-tag@v1
-        with:
-          tag: ${{env.fullVersion}}
-          commit_sha: ${{ github.sha }}
-          message: Workflow run ${{github.server_url}}/${{github.repository}}/actions/runs/${{ github.run_id}}
-
-      - name: replace config/package-solution.json version
-        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' config/package-solution.json
-
-      - name: replace package.json version
-        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' package.json
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build solution
-        run: gulp build
-
-      - name: Bundle and package
-        run: |
-          gulp bundle --ship
-          gulp package-solution --ship
-
-      - name: Upload Build Package
-        uses: actions/upload-artifact@v3
-        with:
-          path: |
-            ${{ env.packagePath }}
-            ${{ env.packagePathUserDocs }}
+# Copyright (c) Laserfiche.
+# Licensed under the MIT License. See LICENSE in the project root for license information.
+
+name: SPFx CI CD
+
+on:
+  push:
+    branches: ['\d+.x']
+  pull_request:
+    branches: ['\d+.x']
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  packagePath: sharepoint/solution/LaserficheSharePointOnlineIntegration.sppkg
+  packagePathUserDocs: UserDocuments
+  fullVersion: 1.0.0.${{github.run_number}}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Tag commit
+        uses: rickstaa/action-create-tag@v1
+        with:
+          tag: ${{env.fullVersion}}
+          commit_sha: ${{ github.sha }}
+          message: Workflow run ${{github.server_url}}/${{github.repository}}/actions/runs/${{ github.run_id}}
+
+      - name: replace config/package-solution.json version
+        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' config/package-solution.json
+
+      - name: replace package.json version
+        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' package.json
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build solution
+        run: gulp build
+
+      - name: Bundle and package
+        run: |
+          gulp bundle --ship
+          gulp package-solution --ship
+
+      - name: Upload Build Package
+        uses: actions/upload-artifact@v3
+        with:
+          path: |
+            ${{ env.packagePath }}
+            ${{ env.packagePathUserDocs }}
diff --git a/.github/workflows/veracode_build.yml b/.github/workflows/veracode_build.yml
index 86b6a17..6ae73d4 100644
--- a/.github/workflows/veracode_build.yml
+++ b/.github/workflows/veracode_build.yml
@@ -1,52 +1,55 @@
-name: Veracode SPFx CI CD
-
-on:
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-  schedule:
-    - cron: '0 12 * * 6'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-
-    - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Setup Node.js environment
-      uses: actions/setup-node@v3
-      with:
-        node-version: 16.x
-
-    - name: Install dependencies
-      run: npm ci
-
-    - name: Build solution
-      run: gulp build
-
-    - name: 'create an empty ./veracode folder'
-      run: 'mkdir -p ./veracode'
-      
-    - name: 'Compress SharePoint files'
-      run: tar -czvf ./veracode/sharepoint-integration.tar.gz ./lib
-
-    
-    - name: Veracode Upload And Scan (Static Application Security Testing)
-      uses: veracode/veracode-uploadandscan-action@0.2.6
-      with:
-        appname: 'SharePoint Integration'
-        createprofile: true
-        filepath: 'veracode'
-        vid: '${{ secrets.VERACODE_API_ID }}'
-        vkey: '${{ secrets.VERACODE_API_KEY }}'
-
-    - name: Run Veracode Software Composition Analysis (SCA)
-      env:
-        SRCCLR_API_TOKEN: ${{ secrets.SRCCLR_API_TOKEN }}
-      uses: veracode/veracode-sca@v2.1.6
-      with:
-        create-issues: false
-        allow-dirty: true
-        recursive: true
-
+# Copyright (c) Laserfiche.
+# Licensed under the MIT License. See LICENSE in the project root for license information.
+
+name: Veracode SPFx CI CD
+
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  schedule:
+    - cron: '0 12 * * 6'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Setup Node.js environment
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16.x
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build solution
+      run: gulp build
+
+    - name: 'create an empty ./veracode folder'
+      run: 'mkdir -p ./veracode'
+      
+    - name: 'Compress SharePoint files'
+      run: tar -czvf ./veracode/sharepoint-integration.tar.gz ./lib
+
+    
+    - name: Veracode Upload And Scan (Static Application Security Testing)
+      uses: veracode/veracode-uploadandscan-action@0.2.6
+      with:
+        appname: 'SharePoint Integration'
+        createprofile: true
+        filepath: 'veracode'
+        vid: '${{ secrets.VERACODE_API_ID }}'
+        vkey: '${{ secrets.VERACODE_API_KEY }}'
+
+    - name: Run Veracode Software Composition Analysis (SCA)
+      env:
+        SRCCLR_API_TOKEN: ${{ secrets.SRCCLR_API_TOKEN }}
+      uses: veracode/veracode-sca@v2.1.6
+      with:
+        create-issues: false
+        allow-dirty: true
+        recursive: true
+
diff --git a/jekyll_files/_config.yml b/jekyll_files/_config.yml
index 3a0c9e0..a187670 100644
--- a/jekyll_files/_config.yml
+++ b/jekyll_files/_config.yml
@@ -1,66 +1,69 @@
-# Jekyll Documentation Generator Configuration File
-
-title: Laserfiche SharePoint Online Integration
-
-exclude:
- # from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
-   - .sass-cache/
-   - .jekyll-cache/
-   - gemfiles/
-   - Gemfile
-   - Gemfile.lock
-   - node_modules/
-   - vendor/bundle/
-   - vendor/cache/
-   - vendor/gems/
-   - vendor/ruby/
- # specific to the theme website:
-   - bin/
-   - lib/
-   - "*.gemspec"
-   - "*.gem"
-   - LICENSE.txt
-   - package.json
-   - package-lock.json
-   - Rakefile
-   - README.md
-   - CODE_OF_CONDUCT.md
-   - docker-compose.yml
-   - Dockerfile
- # theme test code
-   - fixtures/
-
-search_enabled: true
-search:
-  # Split pages into sections that can be searched individually
-  # Supports 1 - 6, default: 2
-  heading_level: 2
-  # Maximum amount of previews per search result
-  # Default: 3
-  previews: 2
-  # Maximum amount of words to display before a matched word in the preview
-  # Default: 5
-  preview_words_before: 3
-  # Maximum amount of words to display after a matched word in the preview
-  # Default: 10
-  preview_words_after: 3
-  # Set the search token separator
-  # Default: /[\s\-/]+/
-  # Example: enable support for hyphenated search words
-  tokenizer_separator: /[\s/]+/
-  # Display the relative url in search results
-  # Supports true (default) or false
-  rel_url: true
-  # Enable or disable the search button that appears in the bottom right corner of every page
-  # Supports true or false (default)
-  button: false
-
-plugins:
-  - jekyll-seo-tag
-  # - jekyll-github-metadata
-  - jekyll-include-cache
-
-heading_anchors: true
-color_scheme: lf-styles
-favicon_ico: "/assets/favicon.webp"
-
+# Copyright (c) Laserfiche.
+# Licensed under the MIT License. See LICENSE in the project root for license information.
+
+# Jekyll Documentation Generator Configuration File
+
+title: Laserfiche SharePoint Online Integration
+
+exclude:
+ # from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
+   - .sass-cache/
+   - .jekyll-cache/
+   - gemfiles/
+   - Gemfile
+   - Gemfile.lock
+   - node_modules/
+   - vendor/bundle/
+   - vendor/cache/
+   - vendor/gems/
+   - vendor/ruby/
+ # specific to the theme website:
+   - bin/
+   - lib/
+   - "*.gemspec"
+   - "*.gem"
+   - LICENSE.txt
+   - package.json
+   - package-lock.json
+   - Rakefile
+   - README.md
+   - CODE_OF_CONDUCT.md
+   - docker-compose.yml
+   - Dockerfile
+ # theme test code
+   - fixtures/
+
+search_enabled: true
+search:
+  # Split pages into sections that can be searched individually
+  # Supports 1 - 6, default: 2
+  heading_level: 2
+  # Maximum amount of previews per search result
+  # Default: 3
+  previews: 2
+  # Maximum amount of words to display before a matched word in the preview
+  # Default: 5
+  preview_words_before: 3
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 3
+  # Set the search token separator
+  # Default: /[\s\-/]+/
+  # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results
+  # Supports true (default) or false
+  rel_url: true
+  # Enable or disable the search button that appears in the bottom right corner of every page
+  # Supports true or false (default)
+  button: false
+
+plugins:
+  - jekyll-seo-tag
+  # - jekyll-github-metadata
+  - jekyll-include-cache
+
+heading_anchors: true
+color_scheme: lf-styles
+favicon_ico: "/assets/favicon.webp"
+
diff --git a/jekyll_files/_includes/js/custom.js b/jekyll_files/_includes/js/custom.js
index e69de29..aece881 100644
--- a/jekyll_files/_includes/js/custom.js
+++ b/jekyll_files/_includes/js/custom.js
@@ -0,0 +1,2 @@
+// Copyright (c) Laserfiche.
+// Licensed under the MIT License. See LICENSE.md in the project root for license information.
diff --git a/jekyll_files/_includes/lunr/custom-index.js b/jekyll_files/_includes/lunr/custom-index.js
index e69de29..66a966e 100644
--- a/jekyll_files/_includes/lunr/custom-index.js
+++ b/jekyll_files/_includes/lunr/custom-index.js
@@ -0,0 +1,3 @@
+// Copyright (c) Laserfiche.
+// Licensed under the MIT License. See LICENSE.md in the project root for license information.
+
diff --git a/jekyll_files/_includes/nav_footer_custom.html b/jekyll_files/_includes/nav_footer_custom.html
index e69de29..4777180 100644
--- a/jekyll_files/_includes/nav_footer_custom.html
+++ b/jekyll_files/_includes/nav_footer_custom.html
@@ -0,0 +1,3 @@
+<!--Copyright (c) Laserfiche.
+Licensed under the MIT License. See LICENSE.md in the project root for license information.-->
+