Upgrade FDC3 website to docusaurus >=3.5.2 #1371 #1418

sivaprasadanakarla · 2024-11-06T04:46:31Z

This update contains all the issue fixes highlighted during review.

Notes from the original PR (#1409):

This PR contains all the files modified for docusaurus migration.
steps followed:

delete yarn.lock

rm -rf node_modules package-lock.json

update package.json
a) "@docusaurus/core": "~3.5.2",
b) "@docusaurus/preset-classic": "~3.5.2",
c) "@docusaurus/theme-mermaid": "~3.5.2",
d) "react": "^18.2.0",
e) "react-dom": "^18.2.0",

npm install. – ( notice- found 0 vulnerabilities)

npm run build. ( now build will fail)

npx docusaurus-mdx-checker (iscans and shows compilation issues of .md files)

Fixed all the .md files and 1 js file which is generating .md file

npm run build (success)

npm run start (application is up)

linux-foundation-easycla · 2024-11-06T04:46:34Z

The committers listed above are authorized under a signed CLA.

✅ login: sivaprasadanakarla / name: Sivaprasad Anakarla (05745af, 27c69d8, 0b50077, 5cf69ee, 01f1cfe, 92f04b6, 31b0854, 2b58c52)
✅ login: kriswest / name: Kris West (079a4b8, c03601e)

netlify · 2024-11-06T04:46:49Z

✅ Deploy Preview for fdc3 canceled.

Name	Link
🔨 Latest commit	`2b58c52`
🔍 Latest deploy log	https://app.netlify.com/sites/fdc3/deploys/672afdb874cffd0008b22024

…natural size

… into Issue#1371

sivaprasadanakarla · 2024-11-06T05:33:01Z

Hi @robmoffat @bingenito ,

[this PR is raised as part of citi_hackathon event]
Could you please review this latest PR for Issue##1371.
We have fixed all the issues highlighted in below PR's.

#1409
#1406

Kindly review and suggest if any other issues.

Thanks in advance.

Best Regards,
Shiva.

DILPREET1910

the \ escape characters are still visible in some sections

DILPREET1910 · 2024-11-06T06:17:10Z

website/versioned_docs/version-2.1/context/ref/Chart.md

this issue still persists
#1406 (comment)

Thank you for highlighting this issue, i will fix it by using triple backticks, it is working fine in my local workspace.

docs/context/ref/Chart.md

bingenito · 2024-11-06T11:37:15Z

toolbox/fdc3-explained/README.md

@@ -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'/>


We lost having the image within the link. Should this be changed to markdown instead of html?

This is just an error that needs reverting I think. The A tag should definitely contain the image still. We may need to look for other cases that need reverting.

Well spotted @bingenito!

The equivalent markdown (for interest's sake) is:

# [![FDC3 Explained Logo](logo.png)](http://fdc3.finos.org/toolbox/fdc3-explained)

bingenito · 2024-11-06T12:11:25Z

website/static/schemas/next/context/timeRange.schema.json

@@ -0,0 +1,62 @@
+{


@kriswest Looks like tooling generated the newly proper cased timeRange side by side with the existing lower timerange.schema.json.

Apologies @bingenito I don't quite understand the comment.

In 2.1 and next I'm only seeing the camelCased fdc3.timeRange schema and generated code in JS and markdown and NOT the uncased fdc3.timerange.

In 2.0 (only) I see the uncased fdc3.timerange

I don't see both in one version - although I am amazed at the number of issues one mistake on the casing of a character (my bad) has caused!

@kriswest
In next it is already present as lower case - https://github.com/finos/FDC3/blob/main/website/static/schemas/next/context/timerange.schema.json

This PR has generated and is now adding the camelCase side by side as it was somehow never there.

Gah, of course that doesn't happen to me locally as the camelcased one is on my filesystem and ensures the case is retained. Behaviour will be different on a case-sensitive file system. Note that the content of that file is actually the camel-cased version!

I dealt with that in the source files, but clearly not in the website's static folder.

Heres a PR that fixes that (I hope) @bingenito: #1420
@sivaprasadanakarla you can ignore this as it should merge into your PR fine.

Actually, @sivaprasadanakarla you must be on a case-insensitive filesystem. I'll get back to you once we have this fix merged as you may need to resolve a conflict once it's in. Nothing to do right now however.

Merged. @sivaprasadanakarla please merge changes from the main branch into your PR branch and then if
/website/static/schemas/next/context/timerange.schema.json still exists, delete it and make sure you only have /website/static/schemas/next/context/timeRange.schema.json

@kriswest working on it.

kriswest · 2024-11-13T16:53:32Z

Hi, you may need to rebase this PR on main and re-run the checks as we've just merged a big PR for a new web-based specification. Hopefully we've not introduced too many extra links using the <{link}> syntax, although I know there are some in the references page. There are likely others.

kriswest · 2024-11-14T17:34:51Z

@sivaprasadanakarla please let us know if you or another participant have some time in the next few days to update this PR from main and make sure several new documents that were recently added (a big PR that had been in flight for many months just merged in) are also all good. We're very grateful that you took this task on and are keen to merge the result and get the website to a clean dependency audit!

sivaprasadanakarla added 3 commits October 29, 2024 16:30

transition from MDX v1 to v3 for Docusaurus v3 upgrade.

31b0854

fix markdown file issues

05745af

fix issues highlighted in PR finos#1406

92f04b6

sivaprasadanakarla requested a review from a team as a code owner November 6, 2024 04:46

kriswest and others added 7 commits November 6, 2024 10:41

Updating interop.io logo and adjusting styles for images without a a …

c03601e

…natural size

more showcase style adjustments

079a4b8

transition from MDX v1 to v3 for Docusaurus v3 upgrade.

5cf69ee

fix markdown file issues

01f1cfe

fix issues highlighted in PR finos#1406

27c69d8

test

0b50077

Merge branch 'Issue#1371' of https://github.com/sivaprasadanakarla/FDC3…

2b58c52

… into Issue#1371

sivaprasadanakarla mentioned this pull request Nov 6, 2024

Upgrade FDC3 website to docusaurus >=3.5.2 #1371 , transition from MDX v1 to v3 for Docusaurus v3 upgrade #1409

Closed

DILPREET1910 mentioned this pull request Nov 6, 2024

refactored docs (markdown files) to be MDX v3 compatible #1406

Closed

DILPREET1910 reviewed Nov 6, 2024

View reviewed changes

bingenito reviewed Nov 6, 2024

View reviewed changes

docs/context/ref/Chart.md Show resolved Hide resolved

bingenito reviewed Nov 6, 2024

View reviewed changes

kriswest mentioned this pull request Nov 13, 2024

Get docusaurus building #1434

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade FDC3 website to docusaurus >=3.5.2 #1371 #1418

Upgrade FDC3 website to docusaurus >=3.5.2 #1371 #1418

sivaprasadanakarla commented Nov 6, 2024 •

edited by kriswest

Loading

linux-foundation-easycla bot commented Nov 6, 2024 •

edited

Loading

netlify bot commented Nov 6, 2024 •

edited

Loading

sivaprasadanakarla commented Nov 6, 2024

DILPREET1910 left a comment

DILPREET1910 Nov 6, 2024

sivaprasadanakarla Nov 13, 2024

bingenito Nov 6, 2024

kriswest Nov 7, 2024 •

edited

Loading

bingenito Nov 6, 2024

kriswest Nov 7, 2024

bingenito Nov 7, 2024

kriswest Nov 7, 2024 •

edited

Loading

kriswest Nov 7, 2024

kriswest Nov 7, 2024

sivaprasadanakarla Nov 13, 2024

kriswest commented Nov 13, 2024

kriswest commented Nov 14, 2024

		@@ -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'/>

Upgrade FDC3 website to docusaurus >=3.5.2 #1371 #1418

Are you sure you want to change the base?

Upgrade FDC3 website to docusaurus >=3.5.2 #1371 #1418

Conversation

sivaprasadanakarla commented Nov 6, 2024 • edited by kriswest Loading

linux-foundation-easycla bot commented Nov 6, 2024 • edited Loading

netlify bot commented Nov 6, 2024 • edited Loading

✅ Deploy Preview for fdc3 canceled.

sivaprasadanakarla commented Nov 6, 2024

DILPREET1910 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kriswest Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kriswest Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kriswest commented Nov 13, 2024

kriswest commented Nov 14, 2024

sivaprasadanakarla commented Nov 6, 2024 •

edited by kriswest

Loading

linux-foundation-easycla bot commented Nov 6, 2024 •

edited

Loading

netlify bot commented Nov 6, 2024 •

edited

Loading

kriswest Nov 7, 2024 •

edited

Loading

kriswest Nov 7, 2024 •

edited

Loading