Merge pull request #1502 from finos/fdc3-web-impl-update-docusaurus

Update website to Docusaurus to 3.7.0

Author: kriswest

.github/workflows/package.yml

@@ -38,13 +38,23 @@ jobs:
       with:
         filters: |
           builtFiles:
-            - '.eslint*'
-            - 'src/**'
-            - 'schemas/**'
+            - 'packages/*/eslint*'
+            - 'packages/*/tsconfig.json'
+            - 'packages/*/src/**'
+            - 'packages/*/schemas/**'
+            - 'packages/*/package-lock.json'
+            - 'packages/*/package.json'
+            - 'packages/*/rollup.config.js'
+            - 'packages/*/s2tQuicktypeUtil.js'
+            - 'packages/fdc3-schema/code-generation/generate-type-predicates.ts'
+            - 'toolbox/fdc3-workbench/src/**'
+            - 'toolbox/fdc3-workbench/package.json'
+            - 'toolbox/fdc3-workbench/package-lock.json'
+            - 'toolbox/fdc3-workbench/eslint.config.mjs'
+            - 'toolbox/fdc3-workbench/tsconfig.json'
+            - 'eslint*'
             - 'package-lock.json'
             - 'package.json'
-            - 'rollup.config.js'
-            - 's2tQuicktypeUtil.js'
             - 'tsconfig.json'
             - '.github/workflows/package.yml'
             
@@ -78,7 +88,7 @@ jobs:
 
       - name: Test
         if: ${{ needs.changes.outputs.builtFiles == 'true' }}
-        run:  npm run test --ci --coverage --maxWorkers=2
+        run:  npm run test
 
       - name: Build
         if: ${{ needs.changes.outputs.builtFiles == 'true' }}

package-lock.json

@@ -1,4 +1,4 @@
-# <a href='http://fdc3.finos.org/toolbox/fdc3-explained'><img src='logo.png' alt='FDC3 Explained Logo'></a>
+# <a href='http://fdc3.finos.org/toolbox/fdc3-explained'><img src='logo.png' alt='FDC3 Explained Logo' /></a>
 
 FDC3 Explained was originally created by Johan Sandersson, an original maintainer of FDC3, and contributed to the project. It shows how easy it is to create very simple HTML and JavaScript that can use the FDC3 APIs to facilitate interoperability.
 

packages/fdc3-schema/generated/api/BrowserTypes.ts

@@ -1,3 +1,3 @@
 FDC3 Workbench - Fintech Open Source Foundation (https://www.finos.org/)
 Copyright 2021-2023 Finsemble, inc. info@finsemble.com
-Copyright 2021 2023 Contributors to the FDC3 standards project
+Copyright 2021-2023 Contributors to the FDC3 standards project

toolbox/fdc3-explained/README.md

@@ -5,7 +5,6 @@ import { fixupPluginRules } from "@eslint/compat";
 import globals from "globals";
 import tsParser from "@typescript-eslint/parser";
 import pluginJs from "@eslint/js";
-import tseslint from "typescript-eslint";
 import eslintConfigPrettier from "eslint-config-prettier";
 import path from "node:path";
 import { fileURLToPath } from "node:url";

toolbox/fdc3-workbench/NOTICE

@@ -13,8 +13,8 @@
     "start": "vite",
     "preview": "vite preview",
     "build": "tsc && vite build",
-    "lint": "eslint --cache --quiet **/*.{ts,tsx,js,jsx} && prettier --check **/*.{ts,tsx,js,jsx,json,yml,css,html,md}",
-    "lint:fix": "eslint --cache --quiet --fix **/*.{ts,tsx,js,jsx} && prettier --write **/*.{ts,tsx,js,jsx} && prettier --write **/*.{json,yml,css,html,md}"
+    "lint": "eslint **/*.{ts,tsx} && prettier --check **/*.{ts,tsx,js,jsx,json,yml,css,html,md}",
+    "lint:fix": "eslint --fix **/*.{ts,tsx} && prettier --write **/*.{ts,tsx,js,jsx} && prettier --write **/*.{json,yml,css,html,md}"
   },
   "eslintConfig": {
     "extends": [

toolbox/fdc3-workbench/eslint.config.mjs

@@ -82,7 +82,7 @@ export async function getTargetOptions(intent: string, context: ContextType): Pr
 			let foundApp = groupedApps.find((app) => app.appId === currentApp.appId);
 			if (!foundApp) {
 				//separate out the instanceId if present
-				// eslint-disable-next-line no-unused-vars
+				// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
 				const { instanceId: _, ...metadata } = currentApp;
 				const option: IntentTargetOption = {
 					appId: currentApp.appId,
@@ -140,7 +140,7 @@ export async function getTargetOptionsForContext(context: ContextType): Promise<
 				let foundApp = groupedApps.find((app) => app.appId === currentApp.appId);
 				if (!foundApp) {
 					//separate out the instanceId if present
-					// eslint-disable-next-line no-unused-vars
+					// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
 					const { instanceId: _, ...metadata } = currentApp;
 					const option: IntentTargetOption = {
 						appId: currentApp.appId,

toolbox/fdc3-workbench/package.json

@@ -1,5 +1,15 @@
 # FDC3 website readme
 
+The FDC3 website is not an integrated part of the FDC3 mono-repo (i.e. its not in `workspaces` element of the main repo's package.json) as it is build separately by netlify. Hence, to build and run the website locally run:
+
+```bash
+cd website
+npm install
+npm run build
+```
+
+Please note that this will *also* build the mono-repo projects via the `prebuild` and `parent-build` scripts as the modules are needed to build UIs (fdc3-workbench and fdc3-reference-ui) hosted within the site.
+
 ## Releasing new versions of the Standard
 
 To create a new version of the website, a number of NPM scripts need to be run that will create the version and update certain content within it (as automatically as possible). There are then a number of additional manual steps to run.
@@ -8,6 +18,7 @@ To create a new version of the website, a number of NPM scripts need to be run t
 
     ```bash
     cd website
+    npm install
     npm run build
     ```
 
@@ -46,17 +57,17 @@ To create a new version of the website, a number of NPM scripts need to be run t
     - Set the `version` filed to the new standard version - but consider appending a beta label, e.g.: `"version": "2.1.0-beta.1",`
     - The new NPM module will be built and submitted to NPM via a Github action automatically when this PR is merged.
 
-7. Test you changes locally by running the site:
+7. Test your changes locally by running the site:
 
     ```bash
-        cd website
-        npm run build
-        npm run start
+    cd website
+    npm run build
+    npm run start
     ```
 
 8. Create a PR and send out details for other maintainers to review and test.
 
 9. Merge the PR - website and NPM module will be deployed automatically.
 
 10. Goto <https://github.com/finos/FDC3/releases> and create a new release and tag for the new version.
-    - Copy the change log into the release description.
+    - Copy the change log into the release description.