search

finos / FDC3

An open standard for the financial desktop.
https://fdc3.finos.org
Other
201 stars 132 forks source link

Get docusaurus building #1434

Open julianna-ciq opened 1 week ago

robmoffat commented 1 week ago

I think moving docs/ into website/ might be a step too far... but I'll leave @kriswest to think about that

julianna-ciq commented 1 week ago

I think moving docs/ into website/ might be a step too far... but I'll leave @kriswest to think about that

Docusaurus is pretty opinionated on where the docs files should live. There were a bunch of build errors that just disappeared once I moved the files into the folder docusaurus likes them to be in. If you want the docs folder to stay separate, I assume that you can, but there's going to be a lot of juggling on someone's part.

kriswest commented 1 week ago

Docusaurus is pretty opinionated on where the docs files should live. There were a bunch of build errors that just disappeared once I moved the files into the folder docusaurus likes them to be in. If you want the docs folder to stay separate, I assume that you can, but there's going to be a lot of juggling on someone's part.

Hmm, thats odd as AFAIK we aren't getting build errors in the pre-refactor version with docs up a level and the docusaurus config pointing at them. Got any details on the errors (out of interest)? Or any details on the juggling needed if we don't do it?

kriswest commented 1 week ago

Oh and we've got this PR hanging out there as part of the Citi Hackathon, which is trying to upgrade existing docs to work in Docusaurus 3: https://github.com/finos/FDC3/pull/1418

I'd guess we'll have to make some similar changes for anything introduced since then. I can ask them to rebase on main as the fdc3 for web docs just got merged in.

julianna-ciq commented 1 week ago

I've updated the copy/paste scripts to move the schemas from the correct place.

kriswest commented 1 week ago

I've updated the copy/paste scripts to move the schemas from the correct place.

Thanks @julianna-ciq, don't forget to run schema2markdown again, it should drop a bunch of the context docs pages from the diff (currently 217 files) by eliminating the change to the schema URL.

I'm seeing some additional differences in the context docs pages that are reverting recent changes, e.g. instrumentList losing its id and name properties: https://github.com/finos/FDC3/pull/1434/files?show-deleted-files=true&show-viewed-files=true&file-filters%5B%5D=#diff-1a9127f623217fd78ece8885a417aca8246835fb70184b8630e7128d1921cf3d

Those should vanish as well, thats probably a result of generating from the 2.1 schemas instead of next 🤞

kriswest commented 1 week ago

@robmoffat and @julianna-ciq I've further corrected the issues in docs generation from context schemas and run the generation. I'm satisfied that is all working correctly. I've also satisfied myself that there are no significant licensing issues around moving either the schemas or docs folders (but then I'm no IP lawyer ;-) ).

I only see one issue with moving the docs folder into /website and that is the docusaurus v3 update PR #1418. @julianna-ciq has done the move correctly so that should merge with this just fine. We just need to get #1418 updated from main, with any additional fixes for recently merged context applied and then merged and we should be good to go.

I would say its safe to merge this into fdc3-for-web-impl while we get #1418 updated and merged.

robmoffat commented 2 days ago

can you re-review? It won't let me merge it until you're not "requesting changes"