docs(website): add Google Analytics (#4531)

<!--  Thanks for sending a pull request!  Here are some tips for you:

#### What type of PR is this?
Docs website enhancement  

#### What this PR does / why we need it:
Add Google Analytics using the same existing GA_ID from
https://github.com/armadaproject/armada/blob/gh-pages/_data/settings.yml#L75

#### Which issue(s) this PR fixes:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
_If PR is about `failing-tests or flakes`, please post the related
issues/tests in a comment and do not use `Fixes`_*
-->
Fixes #

### Special notes for your reviewer:
Add Google Analytics using the existing GA_ID from
https://github.com/armadaproject/armada/blob/gh-pages/_data/settings.yml#L75

### ToDo
- [ ] Add the environment variable `NEXT_PUBLIC_GOOGLE_ANALYTICS_ID` for
GitHub Actions with the value `G-SKPDW30VNF` =>
[creating-configuration-variables-for-a-repository](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables#creating-configuration-variables-for-a-repository)

Signed-off-by: Mehdi Nassim KHODJA <[email protected]>

Author: naskio

.github/workflows/website.yml

@@ -91,6 +91,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NEXT_PUBLIC_REPOSITORY_URL: ${{ env.NEXT_PUBLIC_REPOSITORY_URL }}
           NEXT_PUBLIC_BASE_PATH: ${{ env.NEXT_PUBLIC_BASE_PATH }}
+          NEXT_PUBLIC_GOOGLE_ANALYTICS_ID: ${{ vars.NEXT_PUBLIC_GOOGLE_ANALYTICS_ID }}
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

website/.env.example

@@ -1,3 +1,4 @@
 NEXT_PUBLIC_BASE_PATH="/armada" # optional, used to support GitHub Pages
 NEXT_PUBLIC_REPOSITORY_URL="https://github.com/armadaproject/armada" # optional, used to add links to the repository
+NEXT_PUBLIC_GOOGLE_ANALYTICS_ID="" # optional, Google Analytics ID in the format "G-XXXXXXX"
 GITHUB_TOKEN="" # optional, used for: import { GithubInfo } from 'fumadocs-ui/components/github-info'

website/package.json

@@ -24,6 +24,7 @@
     "spell:check": "cspell lint"
   },
   "dependencies": {
+    "@next/third-parties": "^16.0.1",
     "fumadocs-core": "15.5.5",
     "fumadocs-mdx": "11.6.9",
     "fumadocs-ui": "15.5.5",

website/src/app/layout.tsx

@@ -1,6 +1,7 @@
 import type { ReactNode } from 'react';
 import type { Metadata } from 'next';
 import { Geist } from 'next/font/google';
+import { GoogleAnalytics } from '@next/third-parties/google';
 import { RootProvider } from 'fumadocs-ui/provider';
 import 'katex/dist/katex.min.css';
 import { cn } from '@/utils/cn';
@@ -31,6 +32,9 @@ export default function RootLayout({ children }: { children: ReactNode }) {
           {children}
         </RootProvider>
       </body>
+      {env.googleAnalyticsId && (
+        <GoogleAnalytics gaId={env.googleAnalyticsId} />
+      )}
     </html>
   );
 }

website/src/utils/env.ts

@@ -52,11 +52,19 @@ const envSchema = z.object({
     .string()
     .transform((value) => extractOwnerAndRepo(value).repositoryName)
     .optional(),
+  googleAnalyticsId: z
+    .string()
+    .refine(
+      (value) => !value || /^G-[A-Z0-9]{4,}$/.test(value),
+      `Invalid Google Analytics ID, it should be in the format 'G-XXXX'`
+    )
+    .optional(),
 });
 
 export default envSchema.parse({
   basePath: process.env.NEXT_PUBLIC_BASE_PATH,
   repositoryUrl: process.env.NEXT_PUBLIC_REPOSITORY_URL,
   repositoryOwner: process.env.NEXT_PUBLIC_REPOSITORY_URL,
   repositoryName: process.env.NEXT_PUBLIC_REPOSITORY_URL,
+  googleAnalyticsId: process.env.NEXT_PUBLIC_GOOGLE_ANALYTICS_ID,
 });

website/yarn.lock

@@ -1151,6 +1151,13 @@
   resolved "https://registry.yarnpkg.com/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-15.3.3.tgz#c0e33e069d7922dd0546cac77a0247ad81d4a1aa"
   integrity sha512-4QZG6F8enl9/S2+yIiOiju0iCTFd93d8VC1q9LZS4p/Xuk81W2QDjCFeoogmrWWkAD59z8ZxepBQap2dKS5ruw==
 
+"@next/third-parties@^16.0.1":
+  version "16.0.1"
+  resolved "https://registry.yarnpkg.com/@next/third-parties/-/third-parties-16.0.1.tgz#6023175c8b7ff7e0ea8159e343584b2ef61dbded"
+  integrity sha512-OFgku/XgeZPrPaI33qGqwoLkKW5cN5pY0VKETH2J+cUxY3iboJuYK5gRdcx+crjg/bEo0M38BhPrXHUxBUljwQ==
+  dependencies:
+    third-party-capital "1.0.20"
+
 "@nodelib/[email protected]":
   version "2.1.5"
   resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5"
@@ -8113,6 +8120,11 @@ text-table@^0.2.0:
   resolved "https://registry.yarnpkg.com/text-table/-/text-table-0.2.0.tgz#7f5ee823ae805207c00af2df4a84ec3fcfa570b4"
   integrity sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==
 
+[email protected]:
+  version "1.0.20"
+  resolved "https://registry.yarnpkg.com/third-party-capital/-/third-party-capital-1.0.20.tgz#e218a929a35bf4d2245da9addb8ab978d2f41685"
+  integrity sha512-oB7yIimd8SuGptespDAZnNkzIz+NWaJCu2RMsbs4Wmp9zSDUM8Nhi3s2OOcqYuv3mN4hitXc8DVx+LyUmbUDiA==
+
 time-span@^5.1.0:
   version "5.1.0"
   resolved "https://registry.yarnpkg.com/time-span/-/time-span-5.1.0.tgz#80c76cf5a0ca28e0842d3f10a4e99034ce94b90d"