Skip to content

Update website to Docusaurus to 3.7.0#1502

Merged
kriswest merged 31 commits intomainfrom
fdc3-web-impl-update-docusaurus
Feb 27, 2025
Merged

Update website to Docusaurus to 3.7.0#1502
kriswest merged 31 commits intomainfrom
fdc3-web-impl-update-docusaurus

Conversation

@kriswest
Copy link
Contributor

@kriswest kriswest commented Jan 29, 2025

Describe your change

Updates the FDC3 website to 3.7.0 (superseding/incorporating PR #1418).

After updating a large number of broken links and anchors needed to fixed - docusaurus 2.x was much ore forgiving of capitalisation differences with links and anchors than 3.x. Further, it appears that some accidentally merged the files for version 1.0 -> 1.2 creating many duplicates with broken links. These are all fixed in this PR with only the correct files for each version retained.

Preview: https://deploy-preview-1502--fdc3.netlify.app/

Related Issue

resolves #1371
resolves #1516

Contributor License Agreement

  • I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.

Review Checklist

  • Issue: If a change was made to the FDC3 Standard, was an issue linked above?
  • N/A CHANGELOG: Is a CHANGELOG.md entry included?
    • (website infrastructure doesn't need covering in the Standards CHANGELOG)

@kriswest kriswest requested a review from a team January 29, 2025 18:21
@kriswest kriswest requested a review from a team as a code owner January 29, 2025 18:21
@netlify
Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit 5ef4ff2
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/67bf682f4874860007001563
😎 Deploy Preview https://deploy-preview-1502--fdc3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions
Copy link

504 passed

@github-actions
Copy link

github-actions bot commented Jan 29, 2025

Coverage Report

Commit: 5ef4ff2
Base: main@8fcde04

Type Base This PR
Total Statements Coverage  97.41%  97.41% (+0%)
Total Branches Coverage  86.53%  86.53% (+0%)
Total Functions Coverage  96.85%  96.85% (+0%)
Total Lines Coverage  97.43%  97.43% (+0%)
Details (changed files)
FileStatementsBranchesFunctionsLines
Details (all files)
FileStatementsBranchesFunctionsLines
packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/index.ts 100% 100% 62.5% 100%
packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts 88% 50% 100% 88%
packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts 97.29% 66.66% 100% 97.29%
packages/fdc3-agent-proxy/src/heartbeat/DefaultHeartbeatSupport.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/intents/DefaultIntentResolution.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts 100% 60% 100% 100%
packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts 100% 90% 100% 100%
packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts 100% 77.77% 100% 100%
packages/fdc3-agent-proxy/src/listeners/EventListener.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts 93.33% 72.72% 100% 93.33%
packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts 94.59% 100% 80% 94.59%
packages/fdc3-agent-proxy/src/util/AbstractFDC3Logger.ts 100% 94.11% 100% 100%
packages/fdc3-agent-proxy/src/util/Logger.ts 100% 100% 100% 100%
packages/fdc3-agent-proxy/src/util/throwIfUndefined.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/index.ts 100% 100% 28.57% 100%
packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/messaging/message-port.ts 97.43% 86.66% 100% 97.43%
packages/fdc3-get-agent/src/sessionStorage/DesktopAgentDetails.ts 97.36% 89.47% 100% 97.36%
packages/fdc3-get-agent/src/strategies/DesktopAgentPreloadLoader.ts 100% 81.25% 100% 100%
packages/fdc3-get-agent/src/strategies/FailoverHandler.ts 100% 76.47% 100% 100%
packages/fdc3-get-agent/src/strategies/HelloHandler.ts 94% 81.25% 100% 94%
packages/fdc3-get-agent/src/strategies/IdentityValidationHandler.ts 95.65% 73.33% 100% 95.65%
packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts 98.48% 86.95% 100% 98.46%
packages/fdc3-get-agent/src/strategies/Timeouts.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/strategies/getAgent.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts 97.14% 71.42% 100% 97.01%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts 100% 75% 100% 100%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts 100% 90% 100% 100%
packages/fdc3-get-agent/src/ui/NullChannelSelector.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/ui/NullIntentResolver.ts 100% 100% 66.66% 100%
packages/fdc3-get-agent/src/util/Logger.ts 100% 100% 100% 100%
packages/fdc3-get-agent/src/util/Uuid.ts 100% 100% 100% 100%
packages/fdc3-standard/src/index.ts 100% 100% 0% 100%
packages/fdc3-standard/src/api/Errors.ts 100% 100% 100% 100%
packages/fdc3-standard/src/api/GetAgent.ts 100% 100% 100% 100%
packages/fdc3-standard/src/api/Methods.ts 94.04% 84.05% 96.29% 95%
packages/fdc3-standard/src/api/RecommendedChannels.ts 100% 100% 100% 100%
packages/fdc3-standard/src/context/ContextType.ts 100% 100% 100% 100%
packages/fdc3-standard/src/intents/Intents.ts 100% 100% 100% 100%
packages/fdc3-standard/src/internal/contextConfiguration.ts 100% 100% 100% 100%
packages/fdc3-standard/src/internal/intentConfiguration.ts 100% 100% 100% 100%
packages/fdc3-standard/src/internal/typeHelpers.ts 100% 100% 100% 100%
toolbox/fdc3-for-web/fdc3-web-impl/src/BasicFDC3Server.ts 100% 100% 100% 100%
toolbox/fdc3-for-web/fdc3-web-impl/src/ServerContext.ts 100% 100% 100% 100%
toolbox/fdc3-for-web/fdc3-web-impl/src/directory/BasicDirectory.ts 96.87% 84.21% 100% 96.55%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts 96.38% 86.41% 100% 96.12%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts 88.23% 71.87% 86.66% 90%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts 95.6% 86.56% 100% 95%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts 97.14% 86.84% 100% 97.14%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts 100% 100% 100% 100%

@github-actions
Copy link

504 passed

@kriswest kriswest changed the base branch from main to fdc3-for-web-impl January 29, 2025 18:56
@github-actions
Copy link

504 passed

@kriswest
Copy link
Contributor Author

Closing to repoen (in the hopes that it triggers the a fresh run of the npm-build workflow)

@kriswest kriswest closed this Jan 30, 2025
@github-actions
Copy link

504 passed

@robmoffat
Copy link
Member

@kriswest fixed the schema versioning problem here.

@github-actions
Copy link

504 passed

@kriswest
Copy link
Contributor Author

/netlify

@github-actions
Copy link

504 passed

Copy link
Contributor

@julianna-ciq julianna-ciq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I run docusuaurus build from website/package.json, I get an error

[ERROR] TypeError: Cannot read properties of undefined (reading 'vsDark')
  at Object.<anonymous> (C:\...\website\docusaurus.config.js:52:54)
  ...

which refers to the line
"theme": require('prism-react-renderer').themes.vsDark.

Note that, while prism-react-renderer appears in package-lock.json and in node-modules, it does not appear in package.json's dependencies. Once I added this dep, the build errors went away.

"additionalLanguages": ["typescript","javascript","json","csharp"],
"theme": require('prism-react-renderer/themes/vsDark')
"additionalLanguages": ["typescript", "javascript", "json", "csharp"],
"theme": require('prism-react-renderer').themes.vsDark
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm getting build errors on this line because prism-react-renderer is not included as an explicit dependency in this package.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oddly I don't get errors there (tested on a clean checkout) - but it doesn't hurt to resolve this regardless. Done!

@julianna-ciq
Copy link
Contributor

@kriswest If the above issues are addressed before the SWG meeting tomorrow, I'm happy to approve the PR.

@kriswest kriswest mentioned this pull request Feb 26, 2025
19 tasks
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 26, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@github-actions
Copy link

504 passed

@github-actions
Copy link

504 passed

@kriswest kriswest requested review from a team and julianna-ciq February 26, 2025 19:15
@github-actions
Copy link

504 passed

@kriswest
Copy link
Contributor Author

EasyCLA issues and the last set of review comments from @julianna-ciq are resolved - this should be ready to merge after a final check from any of the @finos/fdc3-desktop-agent-maintainers - then its onto the 2.2 release!

@kriswest kriswest merged commit 59b10d1 into main Feb 27, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

npm run version in website/ directory is failing Upgrade FDC3 website to docusaurus >=3.5.2

6 participants