Docusaurus upgrade #910

robmoffat · 2023-02-22T12:03:16Z

Fixing

Update microsite to docusaurus v2 #762

Major rework was required. Please review the preview carefully.

netlify · 2023-02-22T12:03:21Z

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

Name	Link
🔨 Latest commit	`bb6a273`
🔍 Latest deploy log	https://app.netlify.com/sites/lambent-kulfi-cf51a7/deploys/6401f9e1cb7b4a00095f0770
😎 Deploy Preview	https://deploy-preview-910--lambent-kulfi-cf51a7.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

robmoffat · 2023-02-22T17:05:57Z

Ignore the above preview - it requires some changes to netlify.
You can review here: https://deploy-preview-7--luxury-banoffee-9d872a.netlify.app

julianna-ciq · 2023-02-28T18:18:21Z

Thoughts on content

Page: /docs/references
all of the references include URL's in square brackets, but they aren't actual links. Like this:

Apache 2.0 open-source license, [https://www.apache.org/licenses/LICENSE-2.0].

I assume this aesthetic was intentional, but it might be nice if they were still links that you could actually click on.

Page: /docs/supported-platforms

I like the aesthetic of that code block.

I think that having separate code blocks for npm, yarn, and pnpm works just fine. That said, I just wanted to let you know that I've seen alternatives to it that you might like. On the docusaurus page, they have tabs for npm/yarn/pnpm, so that you can select the code that works for your package manager. I believe that uses npm2yarn

Page: /docs/api/spec#recommended-user-channel-set
You have a blockquote note. If you haven't tried the admonitions before, you may want to see if those also work for you. The syntax would be:

:::note
Future versions of the FDC3 Standard may support connections between desktop agents, where differing user channel sets may cause user experience issues.
:::

Page: /docs/api/ref/DesktopAgent#addintentlistener

Personal preference, but I think using an ordered list might break up this paragraph better:

The Desktop Agent MUST reject the promise returned by the getResult() function of IntentResolution if any of the following is true:

the intent handling function's returned promise rejects

the intent handling function doesn't return a promise

the returned promise resolves to an invalid type.

Sometimes MUST and SHOULD are bolded, and sometimes they aren't. Is there a style guide to recommend whether or not that text should be bolded?

--

Use cases: Why are the use cases numbered and numbers are skipped? I feel like you're just calling attention to a lack of use cases 6, 7, 8, 11, 12, and 14...

robmoffat · 2023-03-01T14:00:40Z

Hi @julianna-ciq,

This is good analysis, but I think it's worth pointing out that I've only really done the change from Docusaurus v1-> v2, so a lot of the stuff you're commenting on is actually things I haven't changed!

Problem is, lots of files have moved locations, so the GitHub diff looks like I've changed everything.

For matters around the actual contents of the documents, @kriswest is probably your man.

kriswest · 2023-03-01T17:50:49Z

I will be most happy to approve any proposed layout improvements that don't change the meaning of the standard. I burnt myself out on editing somewhat last year, but really hope to get back to it post this upgrade. In some cases, the things @julianna-ciq is calling out are v2 features we can now use that we couldn't before or that have changed, possibly the callouts and admonitions for example.

Re: use-cases: before my time, but I think they kept proposal numbers and so those that were not accepted or later superseded are missing. We haven't done anything more than retain the use-cases since FDC3 1.0 or 1.1 I think...

julianna-ciq

Ok, these comments, plus my changes in PR #919 should address all outstanding console errors and broken links that I saw.

julianna-ciq · 2023-03-01T17:52:34Z

website/src/components/ConformanceShowcase/index.js

+    return <div class={styles.conformanceShowcase}>
+        {
+            relevant.map(c => {
+                return (
+                    <div className={styles.conformanceShowcaseItem}>
+                        <div class={styles.conformanceImage}>
+                            <img src={c.conf.image} alt={c.conf.title} title={c.conf.title} />
+                        </div>
+                        <div class={styles.conformanceText}>
+                            <a href={c.conf.infoLink}><h3>{c.conf.title}</h3></a><ul>
+                                {
+                                    c.badge.items.map(item => {
+                                        return (<li class={styles.conformanceItem}>
+                                            <p>{item.text} {  (item.link) ? <em><a href={item.link}>More Details</a></em> :"" }</p>


Suggested change

return <div class={styles.conformanceShowcase}>

{

relevant.map(c => {

return (

<div className={styles.conformanceShowcaseItem}>

<div class={styles.conformanceImage}>

<img src={c.conf.image} alt={c.conf.title} title={c.conf.title} />

</div>

<div class={styles.conformanceText}>

<a href={c.conf.infoLink}><h3>{c.conf.title}</h3></a><ul>

{

c.badge.items.map(item => {

return (<li class={styles.conformanceItem}>

<p>{item.text} { (item.link) ? <em><a href={item.link}>More Details</a></em> :"" }</p>

return <div className={styles.conformanceShowcase}>

{

relevant.map((c, index) => {

return (

<div className={styles.conformanceShowcaseItem} key={`showcase-item-${index}`}>

<div className={styles.conformanceImage}>

<img src={c.conf.image} alt={c.conf.title} title={c.conf.title} />

</div>

<div className={styles.conformanceText}>

<a href={c.conf.infoLink}><h3>{c.conf.title}</h3></a><ul>

{

c.badge.items.map((item, badgeIndex) => {

return (<li className={styles.conformanceItem} key={`badge-item-${badgeIndex}`}>

<p>{item.text} { item.link && <em><a href={item.link}>More Details</a></em>}</p>

There were some console errors on this page around the use of class instead of className and around not using keys where necessary.

I have tested this suggestion, and it fixes the console errors.

julianna-ciq · 2023-03-01T17:54:23Z

website/src/components/GridBlock/index.js

+          items.map(sl =>
+            <div className="blockElement fourByGridBlock">


Suggested change

items.map(sl =>

<div className="blockElement fourByGridBlock">

items.map((sl, index) =>

<div className="blockElement fourByGridBlock" key={index}>

There were console errors around the fact that this DIV didn't have the necessary key prop. I have tested this suggestion, and it addresses the errors.

julianna-ciq · 2023-03-01T17:58:34Z

website/src/pages/community.js

+								<div className="conformance-badge"><img src={c.src} /></div>
+								<div className="conformance-text"><ul>
+									{
+										c.items.map(ti => <li key={ti.link}>{ti.text} { ti.link ? <a className="conformance-details" href={ti.link}>details</a> : "" }</li>)


Suggested change

c.items.map(ti => <li key={ti.link}>{ti.text} { ti.link ? <a className="conformance-details" href={ti.link}>details</a> : "" }</li>)

c.items.map(ti => <li key={ti.text}>{ti.text} { ti.link ? <a className="conformance-details" href={ti.link}>details</a> : "" }</li>)

There were errors around this LI elements key prop not being unique. When the key was based on a link (URL), it assumed all of the conformance details would point to different URL's; however several links on this page all point to the same press release.

Since all of the text on this page is different, I've changed the key to be based on the text. In the event that multiple details links will have the same link text, the page will throw errors again.

I have tested the suggested change.

julianna-ciq · 2023-03-01T18:01:10Z

website/src/pages/fdc3-roadmap.js

@@ -0,0 +1,160 @@
+import Layout from "@theme/Layout";


There are console errors on this page for the following changes:

All uses of class should be className

All uses of colspan should be colSpan, and rowspan should be rowSpan

All the TR tags (not under THEAD) should be children of a TBODY element.

website/versioned_docs/version-1.0/api/ref/Channel.md

website/versioned_docs/version-1.1/appd-spec.md

website/versioned_docs/version-1.2/appd-spec.md

website/versioned_docs/version-1.2/intents/overview.md

website/versioned_docs/version-2.0/intents/overview.md

robmoffat · 2023-03-02T10:52:04Z

now with improved dark mode. something broke the preview though:

89
> copy-explained
[90](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:91)
> del-cli static/toolbox/fdc3-explained && cpy ./fdc3-explained ../website/static/toolbox --parents  --cwd=../toolbox
[91](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:92)

[92](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:93)

[93](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:94)
> build
[94](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:95)
> docusaurus build
[95](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:96)

[96](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:97)
[INFO] [en] Creating an optimized production build...
[97](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:98)
Warning:  Cannot infer the update date for some files, as they are not tracked by git.
[98](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:99)
[info] [webpackbar] Compiling Client
[99](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:100)
[info] [webpackbar] Compiling Server
[100](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:101)
node:internal/event_target:969
[101](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:102)
  process.nextTick(() => { throw err; });
[102](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:103)
                           ^
[103](https://github.com/robmoffat/FDC3/actions/runs/4313148735/jobs/7524583880#step:7:104)

docs: Fix a couple of broken links in the docs site

Drop cosaic from docs as defunct

robmoffat · 2023-03-03T11:59:01Z

@kriswest and @julianna-ciq please review

I've fixed all the remaining broken links and the Netlify preview is now working.

I'm assuming all the items of conversation above have been fixed by your PR into this one?

thanks!

kriswest · 2023-03-03T12:57:13Z

I believe the comments ended up split between suggestions above that needed to be commited and PR for files that weren't affected/moved by your PR... K

…

On Fri, 3 Mar 2023, 11:59 Rob Moffat, ***@***.***> wrote: @kriswest <https://github.com/kriswest> and @julianna-ciq <https://github.com/julianna-ciq> please review I've fixed all the remaining broken links and the Netlify preview is now working. I'm assuming all the items of conversation above have been fixed by your PR into this one? thanks! — Reply to this email directly, view it on GitHub <#910 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAM7PBAEQTVZNJWBWHLZWA3W2HMJBANCNFSM6AAAAAAVEHYRKQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Co-authored-by: julianna-ciq <74684272+julianna-ciq@users.noreply.github.com>

kriswest

LGTM - side issue raised for content improvements

kriswest · 2023-03-03T17:38:27Z

@robmoffat It doesn't look like this has deployed... See https://github.com/finos/FDC3/actions/runs/4324087758

The github action for deploying it probably also needs updating.

robmoffat · 2023-03-06T14:09:09Z

I'm talking with Juan on this. I believe the action actually needs to be removed but not completely sure right now

…

On Fri, Mar 3, 2023 at 5:38 PM Kris West ***@***.***> wrote: @robmoffat <https://github.com/robmoffat> It doesn't look like this has deployed... See https://github.com/finos/FDC3/actions/runs/4324087758 The github action for deploying it probably also needs updating. — Reply to this email directly, view it on GitHub <#910 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEK2YOC3DBWJ2OVJKZTY5TW2IUB5ANCNFSM6AAAAAAVEHYRKQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

kriswest · 2023-03-06T17:47:43Z

The action needs to exist to deploy - but will no doubt need updating after the upgrade... Unless you are suggesting moving to a manual deployment of some sort.

…

On Mon, 6 Mar 2023 at 14:09, Rob Moffat ***@***.***> wrote: I'm talking with Juan on this. I believe the action actually needs to be removed but not completely sure right now On Fri, Mar 3, 2023 at 5:38 PM Kris West ***@***.***> wrote: > @robmoffat <https://github.com/robmoffat> It doesn't look like this has > deployed... See https://github.com/finos/FDC3/actions/runs/4324087758 > > The github action for deploying it probably also needs updating. > > — > Reply to this email directly, view it on GitHub > <#910 (comment)>, or > unsubscribe > < https://github.com/notifications/unsubscribe-auth/AAEK2YOC3DBWJ2OVJKZTY5TW2IUB5ANCNFSM6AAAAAAVEHYRKQ > > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> > — Reply to this email directly, view it on GitHub <#910 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAM7PBGFXBQZWEAVDXWPPFDW2XVZDANCNFSM6AAAAAAVEHYRKQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Kris West *he • him* *Principal Engineer* [image: Finsemble] <https://finsemble.com/> ***@***.*** finsemble.com

robmoffat added 18 commits February 17, 2023 10:55

Working in website v2

4a8a8ad

Got 1.2 docs working

0c40f53

Moved assets

09cf1c0

Site compiling correctly

ca06cc7

Site compiling correctly

4f643e8

Fixed versioning

b09298c

Fixing pages: versions, users

335b148

fixed roadmap

d89feb2

Fixed get involved

586a251

Working on index page

7606696

Index page working

6b8d35b

Added footer, fixed dark mode

799d07c

Replaced old website, fixed versions

1b54ef6

Fixed version dropdown

d6bc462

Fixed bug on versions page

88a221c

Fixed front-page styling

6e14eba

Fixed react page errors

c391ebf

Fixed page selectors on community page

60227fb

robmoffat requested review from a team February 22, 2023 17:06

robmoffat added 8 commits February 23, 2023 10:15

Fixing 1.0 broken links

4ca9161

Fixed 1.1 links:

c344688

Fixing 1.2 broken links

194a4d3

Fixed broken links in next

8f31981

Fixed 2.0 links

87e3bcd

Removed the generated directory

0d3a596

Added front page conformance details

ff1039b

Added OpenFin Conformance

c327869

Fix some broken links

547b142

julianna-ciq reviewed Mar 1, 2023

View reviewed changes

robmoffat added 2 commits March 2, 2023 09:28

Fixing more broken links

96bb386

Fixing css issues with Kris

0e90f8b

kriswest and others added 6 commits March 2, 2023 12:11

Merge branch 'docusaurus-upgrade' into docs-site-erros

747dcea

Update website/versioned_docs/version-1.0/appd-spec.md

3c142d7

Merge pull request #919 from Finsemble/docs-site-erros

512624d

docs: Fix a couple of broken links in the docs site

Merge pull request #918 from finos/drop-cosaic-from-docs-as-defunct

d8b4f5b

Drop cosaic from docs as defunct

Updated deps

d32c08e

Fixed css, remaining issues in build

ad803fe

robmoffat requested a review from kriswest March 3, 2023 11:58

robmoffat and others added 3 commits March 3, 2023 13:44

Update website/src/pages/fdc3-roadmap.js

e4c4579

Co-authored-by: julianna-ciq <74684272+julianna-ciq@users.noreply.github.com>

Update website/src/pages/fdc3-roadmap.js

322c212

Co-authored-by: julianna-ciq <74684272+julianna-ciq@users.noreply.github.com>

Update website/src/pages/fdc3-roadmap.js

bb6a273

Co-authored-by: julianna-ciq <74684272+julianna-ciq@users.noreply.github.com>

robmoffat mentioned this pull request Mar 3, 2023

Address Content and Accessability issues in FDC3 website #921

Closed

kriswest approved these changes Mar 3, 2023

View reviewed changes

robmoffat merged commit 129f741 into master Mar 3, 2023

kriswest mentioned this pull request Mar 9, 2023

Update microsite to docusaurus v2 #762

Closed

kriswest mentioned this pull request Mar 20, 2023

FDC3 Explained: SemGrep Failures #811

Closed

julianna-ciq mentioned this pull request Apr 12, 2023

docs: Make references page's hrefs into links #952

Merged

1 task

kriswest deleted the docusaurus-upgrade branch November 13, 2024 18:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docusaurus upgrade #910

Docusaurus upgrade #910

robmoffat commented Feb 22, 2023 •

edited

Loading

netlify bot commented Feb 22, 2023 •

edited

Loading

robmoffat commented Feb 22, 2023 •

edited

Loading

julianna-ciq commented Feb 28, 2023

robmoffat commented Mar 1, 2023 •

edited

Loading

kriswest commented Mar 1, 2023

julianna-ciq left a comment

julianna-ciq Mar 1, 2023

julianna-ciq Mar 1, 2023

julianna-ciq Mar 1, 2023

julianna-ciq Mar 1, 2023

robmoffat commented Mar 2, 2023

robmoffat commented Mar 3, 2023

kriswest commented Mar 3, 2023 via email

kriswest left a comment

kriswest commented Mar 3, 2023

robmoffat commented Mar 6, 2023 via email

kriswest commented Mar 6, 2023 via email

		items.map(sl =>
		<div className="blockElement fourByGridBlock">

	c.items.map(ti => <li key={ti.link}>{ti.text} { ti.link ? <a className="conformance-details" href={ti.link}>details</a> : "" }</li>)
	c.items.map(ti => <li key={ti.text}>{ti.text} { ti.link ? <a className="conformance-details" href={ti.link}>details</a> : "" }</li>)

Docusaurus upgrade #910

Docusaurus upgrade #910

Conversation

robmoffat commented Feb 22, 2023 • edited Loading

netlify bot commented Feb 22, 2023 • edited Loading

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

robmoffat commented Feb 22, 2023 • edited Loading

julianna-ciq commented Feb 28, 2023

robmoffat commented Mar 1, 2023 • edited Loading

kriswest commented Mar 1, 2023

julianna-ciq left a comment

Choose a reason for hiding this comment

julianna-ciq Mar 1, 2023

Choose a reason for hiding this comment

julianna-ciq Mar 1, 2023

Choose a reason for hiding this comment

julianna-ciq Mar 1, 2023

Choose a reason for hiding this comment

julianna-ciq Mar 1, 2023

Choose a reason for hiding this comment

robmoffat commented Mar 2, 2023

robmoffat commented Mar 3, 2023

kriswest commented Mar 3, 2023 via email

kriswest left a comment

Choose a reason for hiding this comment

kriswest commented Mar 3, 2023

robmoffat commented Mar 6, 2023 via email

kriswest commented Mar 6, 2023 via email

robmoffat commented Feb 22, 2023 •

edited

Loading

netlify bot commented Feb 22, 2023 •

edited

Loading

robmoffat commented Feb 22, 2023 •

edited

Loading

robmoffat commented Mar 1, 2023 •

edited

Loading