Docusaurus v3

.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: Build check
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+
+      - run: npm ci
+
+      - run: npm run typecheck
+
+      - run: npm run build

.github/workflows/deploy.yml

@@ -17,14 +17,12 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .nvmrc
           cache: npm
 
       - run: npm ci
 
       - run: npm run build
-        env:
-          NODE_OPTIONS: --openssl-legacy-provider
 
       - uses: peaceiris/actions-gh-pages@v4
         with:

.nvmrc

@@ -0,0 +1 @@
+22

docs/administration.md

@@ -236,7 +236,7 @@ Once the files are in place, you can enable https by going to the [Server Settin
 Restart the server for changes to take affect.
 - [On-Premise](on-prem.mdx#startstop-flexit-server)
 - [Docker (Linux)](docker.md#restarting-the-application)
-- [Docker (Windows)](docker-windows.md#srestarting-the-application) 
+- [Docker (Windows)](docker-windows.md#restarting-the-application) 
 
 > Note: You may also need to change the port to 443, see the [Server Settings](#server-settings) administration section.
 

docs/cloud.md

@@ -13,4 +13,4 @@ FlexIt can be deployed to the cloud. Click *Get FlexIt* below to get started.
 
 Spin up a 100% free cloud deployment on Heroku for small deployments or proof-of-concepts. When you're ready to scale up, [contact us](https://flexitanalytics.com/sales/) to help with your Amazon Web Services deployment.
 
-<a class="button button--outline button--primary button--lg" href="https://flexitanalytics.com/download">Get FlexIt</a>
+<a className="button button--outline button--primary button--lg" href="https://flexitanalytics.com/download">Get FlexIt</a>

docs/dbt.mdx

@@ -55,7 +55,7 @@ This guide assumes that you already have a dbt environment set up, and a FlexIt
 
 ## Connect to your data warehouse
 
-:::caution Required
+:::warning Required
 
 You need to [create a data source connection](administration.md#data-sources) in FlexIt that will connect to the dbt project databases. dbt holds metadata, but that does not include database connection details.
 

docs/docker-windows.md

@@ -210,10 +210,10 @@ run bash from within the container (linux):
 docker exec -it flexit-analytics /bin/bash
 ```
 
-<!-- run cmd from within the container (windows):
+{/* run cmd from within the container (windows):
 ```bash
 docker exec -it flexit-analytics cmd
-``` -->
+``` */}
 
 To view the volumes:
 

docs/docker.md

@@ -226,10 +226,10 @@ run bash from within the container (linux):
 sudo docker exec -it flexit-analytics /bin/bash
 ```
 
-<!-- run cmd from within the container (windows):
+{/* run cmd from within the container (windows):
 ```bash
 sudo docker exec -it flexit-analytics cmd
-``` -->
+``` */}
 
 To view the volumes:
 

docs/on-prem.mdx

@@ -17,7 +17,7 @@ FlexIt can be downloaded and installed on your local servers on premises (a.k.a
 
 You need to have the FlexIt installer for the applicable operating system. If you have not already downloaded the FlexIt installer, please download now:
 
-<a class="button button--outline button--primary button--lg" href="https://flexitanalytics.com/download">Get FlexIt</a>
+<a className="button button--outline button--primary button--lg" href="https://flexitanalytics.com/download">Get FlexIt</a>
 
 #### System Requirements
 

docs/report.md

@@ -159,7 +159,7 @@ You can also drill down or across on any text/dimension field. The example below
 
 ![Drill dimension](/img/report/drill_dimension.gif)
 
-You can also drill to external websites and pass columns from the report to the URL parameters. To pass a column from the report, put it in the URL inside of {} curley braces. You can also set a condition to only allow the drill when certain criteria are met. For example, you could create a drill on *Athlete Name* that opens a Google Search, as shown below.
+You can also drill to external websites and pass columns from the report to the URL parameters. To pass a column from the report, put it in the URL inside of `{}` curley braces. You can also set a condition to only allow the drill when certain criteria are met. For example, you could create a drill on *Athlete Name* that opens a Google Search, as shown below.
 
 ![Drill URL](/img/report/drill_url.png)
 
@@ -319,8 +319,8 @@ Select a file in the top-left, then a sheet if you're using Excel. The data will
 **Load Data**
 
 When loading data into a database, you will take three steps:
-1. Select Destination Table ([see more](etl.md/#destination))
-2. Map Columns ([see more](etl.md/#column-mapping))
+1. Select Destination Table ([see more](etl.md#destination))
+2. Map Columns ([see more](etl.md#column-mapping))
 3. Run Data Load
 
 **Create Report**
@@ -331,4 +331,6 @@ Instantly analyze your data. Please note that you cannot save this report unless
 
 You can filter a report using query string parameters in the URL. The required URL format uses the `specs` parameter and JSON format to allow for simple and advanced filter structures. You can pass any type of filter that can be built in FlexIt. To see the format used, build a report with the desired filter, then go to [Report Options](#report-options) and select More Settings. From there, expand the Report Specifications and look for the `filters` JSON object, which will be the exact structure you can use. Here is an example that also shows how to change report `name` and `uiaction` (run or prompt):
 
-https://cloud.flexitanalytics.com/?specs={"name":"helloworld","uiaction":"run","filters":[{"id":"COUNTRY.COUNTRY_CODE","selections":[{"use":"USA"}]}]}#analysis/olympic-data-detail/embed
+```
+https://cloud.flexitanalytics.com/?specs={"name":"helloworld","uiaction":"run","filters":[{"id":"COUNTRY.COUNTRY_CODE","selections":[{"use":"USA"}]}]}#analysis/olympic-data-detail/embed
+```

docusaurus.config.js

@@ -1,111 +1,85 @@
-/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
+// @ts-check
 
-module.exports = {
+/** @type {import('@docusaurus/types').Config} */
+const config = {
   title: 'Welcome to FlexIt Learning',
   tagline: 'FlexIt Analytics is business intelligence, built for people',
-  url: 'https://flexit.github.io',
+  url: 'https://learn.flexitanalytics.com',
   baseUrl: '/',
-  favicon: '/img/Flex-X-small.png',
-  organizationName: 'flexanalytics', // Usually your GitHub org/user name.
-  projectName: 'flexit-docs', // Usually your repo name.
-  themeConfig: {
-    zoomSelector: '.markdown :not(em) > img',
-    algolia: {
-      apiKey: '04948da940dc579697cd957e0acf432b',
-      indexName: 'flexitanalytics',
-      algoliaOptions: {}, // Optional, if provided by Algolia
-    },
-    gtag: {
-      trackingID: 'UA-127440102-1',
-    },
-    navbar: {
-      title: 'FlexIt Documentation',
-      logo: {
-        alt: 'FlexIt',
-        src: '/img/Flex-X-small.png',
-      },
-      items: [
-        {to: 'docs/getting-started', label: 'Docs', position: 'right'},
-        //{to: 'docs/deploy', label: 'Deploy', position: 'right'},
-        //{to: 'docs/administration', label: 'Administration', position: 'right'},
-        {
-          href: 'https://flexitanalytics.com',
-          label: 'FlexIt Website',
-          position: 'right',
-          'aria-label': 'Open FlexIt Analytics website in new window',
-        },
-      ],
-    },
-    footer: {
-      style: 'dark',
-      links: [
-        /*
-        {
-          title: 'Deploy',
-          items: [
-            {
-              label: 'Deploy',
-              to: 'docs/deploy',
-            },
-          ],
-        },
-        {
-          title: 'Administration',
-          items: [
-            {
-              label: 'Administration',
-              to: 'docs/administration',
-            },
-          ],
-        },
-        {
-          title: 'FlexIt Website',
-          items: [
-            {
-              label: 'FlexIt Website',
-              href: 'https://flexitanalytics.com',
-            },
-          ],
-        },
-        */
-      ],
-      /*
-      logo: {
-        alt: 'FlexIt Logo',
-        src: '/img/Flex-X-small.png',
-        href: 'https://flexitanalytics.com/',
-      },
-      */
-      copyright: `Copyright © ${new Date().getFullYear()} Flex Analytics, Inc.`,
+  favicon: 'img/Flex-X-small.png',
+  organizationName: 'flexanalytics',
+  projectName: 'flexit-docs',
+
+  onBrokenLinks: 'throw',
+  onBrokenAnchors: 'throw',
+
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: 'throw',
     },
   },
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
   presets: [
     [
-      '@docusaurus/preset-classic',
-      {
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
           editUrl: 'https://github.com/flexanalytics/flexit-docs/edit/master/',
-          //showLastUpdateAuthor: true,
-          //showLastUpdateTime: true,
         },
+        blog: false,
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
         },
-      },
+        gtag: {
+          trackingID: 'UA-127440102-1',
+          anonymizeIP: true,
+        },
+      }),
     ],
   ],
-  stylesheets: [
-    //'node_modules/@fortawesome/fontawesome-pro/css/all.css',
-  ],
-  scripts: [
-  ],
-  plugins: [
-    'plugin-image-zoom'
-  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      zoomSelector: '.markdown :not(em) > img',
+      algolia: {
+        appId: 'BH4D9OD16A',
+        apiKey: '04948da940dc579697cd957e0acf432b',
+        indexName: 'flexitanalytics',
+        // Index was crawled by legacy DocSearch and has no docusaurus_tag facet
+        contextualSearch: false,
+      },
+      navbar: {
+        title: 'FlexIt Documentation',
+        logo: {
+          alt: 'FlexIt',
+          src: 'img/Flex-X-small.png',
+        },
+        items: [
+          {to: '/docs/getting-started', label: 'Docs', position: 'right'},
+          {
+            href: 'https://flexitanalytics.com',
+            label: 'FlexIt Website',
+            position: 'right',
+            'aria-label': 'Open FlexIt Analytics website in new window',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [],
+        copyright: `Copyright © ${new Date().getFullYear()} Flex Analytics, Inc.`,
+      },
+    }),
+
+  plugins: ['plugin-image-zoom'],
 };
+
+module.exports = config;