Upgrade FDC3 website to docusaurus >=3.5.2 #1371 , transition from MDX v1 to v3 for Docusaurus v3 upgrade #1409
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
transition from MDX v1 to v3 for Docusaurus v3 upgrade.
|
|
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
This is amazing, thank you! I assume you are part of the Citi Hackathon? Can you share who you work for if anyone, so that we can begin the CLA process? thanks, |
bingenito
reviewed
Oct 31, 2024
bingenito
reviewed
Oct 31, 2024
| @@ -1476,7 +1476,7 @@ Not implemented | |||
| </TabItem> | |||
| </Tabs> | |||
|
|
|||
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard <2.0. | |||
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard\<2.0. | |||
There was a problem hiding this comment.
The escape in all these instances replaced the space so resulting format is now "standard<2.0"
There was a problem hiding this comment.
Suggested change
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard\<2.0. | |
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard <2.0. |
bingenito
reviewed
Oct 31, 2024
| @@ -138,7 +138,7 @@ A launcher can then easily construct a URI by: | |||
| 3. URI port is default `https/443`, but can be overridden by the launcher | |||
| 4. URI url is by default `/api/appd/(version)/apps` . Calls that are made without version MUST automatically default to latest, i.e. `/api/appd/apps/app1` should return the same result as `/api/appd/v2/apps/app1". | |||
|
|
|||
| The resulting URI to retrieve application data for `app1` would be <https://appd.foo.com/api/appd/v2/apps/[email protected]> | |||
| The resulting URI to retrieve application data for `app1` would be https://appd.foo.com/api/appd/v2/apps/[email protected] [https://appd.foo.com/api/appd/v2/apps/[email protected]](https://appd.foo.com/api/appd/v2/apps/[email protected]) | |||
There was a problem hiding this comment.
The replace on this one kept original link in place so it is now repeated.
bingenito
reviewed
Oct 31, 2024
| @@ -8,7 +8,7 @@ sidebar_label: BaseContext | |||
|
|
|||
| ## Schema | |||
|
|
|||
| <https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json> | |||
| https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) | |||
There was a problem hiding this comment.
This looks like a double link
bingenito
reviewed
Oct 31, 2024
| @@ -24,7 +24,7 @@ can be expected to have, but this can always be extended with custom fields as a | |||
|
|
|||
| ## Schema | |||
|
|
|||
| <https://fdc3.finos.org/schemas/next/context/context.schema.json> | |||
| https://fdc3.finos.org/schemas/next/context/context.schema.json [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json) | |||
bingenito
reviewed
Oct 31, 2024
| @@ -8,7 +8,7 @@ sidebar_label: DocumentedContext | |||
|
|
|||
| ## Schema | |||
|
|
|||
| <https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json> | |||
| https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) | |||
bingenito
reviewed
Oct 31, 2024
| @@ -8,7 +8,7 @@ sidebar_label: DocumentedContext | |||
|
|
|||
| ## Schema | |||
|
|
|||
| <https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json> | |||
| https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) | |||
There was a problem hiding this comment.
Suggested change
| https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) | |
| [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) |
bingenito
reviewed
Oct 31, 2024
| @@ -24,7 +24,7 @@ can be expected to have, but this can always be extended with custom fields as a | |||
|
|
|||
| ## Schema | |||
|
|
|||
| <https://fdc3.finos.org/schemas/next/context/context.schema.json> | |||
| https://fdc3.finos.org/schemas/next/context/context.schema.json [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json) | |||
There was a problem hiding this comment.
Suggested change
| https://fdc3.finos.org/schemas/next/context/context.schema.json [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json) | |
| [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json) |
bingenito
reviewed
Oct 31, 2024
| @@ -138,7 +138,7 @@ A launcher can then easily construct a URI by: | |||
| 3. URI port is default `https/443`, but can be overridden by the launcher | |||
| 4. URI url is by default `/api/appd/(version)/apps` . Calls that are made without version MUST automatically default to latest, i.e. `/api/appd/apps/app1` should return the same result as `/api/appd/v2/apps/app1". | |||
|
|
|||
| The resulting URI to retrieve application data for `app1` would be <https://appd.foo.com/api/appd/v2/apps/[email protected]> | |||
| The resulting URI to retrieve application data for `app1` would be https://appd.foo.com/api/appd/v2/apps/[email protected] [https://appd.foo.com/api/appd/v2/apps/[email protected]](https://appd.foo.com/api/appd/v2/apps/[email protected]) | |||
There was a problem hiding this comment.
Suggested change
| The resulting URI to retrieve application data for `app1` would be https://appd.foo.com/api/appd/v2/apps/[email protected] [https://appd.foo.com/api/appd/v2/apps/[email protected]](https://appd.foo.com/api/appd/v2/apps/[email protected]) | |
| The resulting URI to retrieve application data for `app1` would be [https://appd.foo.com/api/appd/v2/apps/[email protected]](https://appd.foo.com/api/appd/v2/apps/[email protected]) |
bingenito
reviewed
Oct 31, 2024
| @@ -8,7 +8,7 @@ sidebar_label: BaseContext | |||
|
|
|||
| ## Schema | |||
|
|
|||
| <https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json> | |||
| https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) | |||
There was a problem hiding this comment.
Suggested change
| https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) | |
| [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json) |
bingenito
reviewed
Oct 31, 2024
| @@ -97,7 +97,7 @@ or in JSON Schema as: | |||
|
|
|||
| :::note | |||
|
|
|||
| This is a simplified version of the schema for illustrative purposes, the fully documented Context schema, which is composed with other FDC3 Standard context schemas, can be found at: <https://fdc3.finos.org/schemas/next/context/context.schema.json>. | |||
| This is a simplified version of the schema for illustrative purposes, the fully documented Context schema, which is composed with other FDC3 Standard context schemas, can be found at: https://fdc3.finos.org/schemas/next/context/context.schema.json [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json). | |||
There was a problem hiding this comment.
Suggested change
| This is a simplified version of the schema for illustrative purposes, the fully documented Context schema, which is composed with other FDC3 Standard context schemas, can be found at: https://fdc3.finos.org/schemas/next/context/context.schema.json [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json). | |
| This is a simplified version of the schema for illustrative purposes, the fully documented Context schema, which is composed with other FDC3 Standard context schemas, can be found at: [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json). |
bingenito
reviewed
Oct 31, 2024
| @@ -21,7 +21,7 @@ To run the website locally | |||
|
|
|||
| ```yarn start``` | |||
|
|
|||
| This will open the home page or browse to <https://localhost:3000> | |||
| This will open the home page or browse to https://localhost:3000 [https://localhost:3000](https://localhost:3000) | |||
There was a problem hiding this comment.
Suggested change
| This will open the home page or browse to https://localhost:3000 [https://localhost:3000](https://localhost:3000) | |
| This will open the home page or browse to [https://localhost:3000](https://localhost:3000) |
|
Hi @robmoffat , Jamie Slome is our Org CLA manager. |
|
/easycla |
|
HI @sivaprasadanakarla, please take a look at the EasyCLA message above. A couple of commits in your PR appear to be missing author information, which will need to be corrected. See the help files at: https://linuxfoundation.atlassian.net/wiki/spaces/LP/pages/160923756/Missing+ID+on+Commit+but+I+have+an+agreement+on+file and https://docs.github.com/en/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user to help you corrrect this. Once done, the first error in the EasyCLA comment should disappear. Then to resolve the second one, please cklick on the Please click here to be authorized link. This will take you to an authorization form that will help you send a message to @JamieSlome to authorize you against the CLA. |
kriswest
requested changes
Nov 4, 2024
There was a problem hiding this comment.
Hi @sivaprasadanakarla , many thanks for taking this on. We have another overlapping PR #1406 that also addresses #1371 which we may need to combine with this one - there are merits to both and corrections are needed in both. It might be worth comparing the two PRs, see:
- sivaprasadanakarla/FDC3@sivaprasadanakarla:FDC3:main...DILPREET1910:FDC3:main
- DILPREET1910/FDC3@main...sivaprasadanakarla:FDC3:main
In particular, take a look at some of the escapes used in the other PR.
| @@ -11,7 +11,7 @@ export default function Training() { | |||
|
|
|||
| <div className={styles.trainingList}> | |||
| <div className={styles.trainingItem}> | |||
| <h2>Introduction to FDC3 (LFEL1000)</h2> | |||
| <h2>Introduction to FDC3 (LFEL1000)</h2> | |||
There was a problem hiding this comment.
Introducing a double space?
| @@ -725,7 +725,7 @@ await fdc3.raiseIntentForContext(context, targetAppIdentifier); | |||
| addContextListener(handler: ContextHandler): Promise<Listener>; | |||
| ``` | |||
|
|
|||
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard <2.0. | |||
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard\<2.0. | |||
There was a problem hiding this comment.
bad escape, use < and make sure you don't lose the space
| @@ -759,7 +759,7 @@ Alias to the [`joinUserChannel`](#joinuserchannel) function provided for backwar | |||
| open(name: String, context?: Context): Promise<AppIdentifier>; | |||
| ``` | |||
|
|
|||
| Version of `open` that launches an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard <2.0. | |||
| Version of `open` that launches an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard\<2.0. | |||
There was a problem hiding this comment.
bad escape, use < and make sure you don't lose the space
| @@ -771,7 +771,7 @@ Version of `open` that launches an app by name rather than `AppIdentifier`. Prov | |||
| raiseIntent(intent: string, context: Context, name: String): Promise<IntentResolution>; | |||
| ``` | |||
|
|
|||
| Version of `raiseIntent` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard <2.0. | |||
| Version of `raiseIntent` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard\<2.0. | |||
There was a problem hiding this comment.
bad escape, use < and make sure you don't lose the space
| @@ -783,7 +783,7 @@ Version of `raiseIntent` that targets an app by name rather than `AppIdentifier` | |||
| raiseIntentForContext(context: Context, name: String): Promise<IntentResolution>;; | |||
| ``` | |||
|
|
|||
| Version of `raiseIntentForContext` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard <2.0. | |||
| Version of `raiseIntentForContext` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard\<2.0. | |||
There was a problem hiding this comment.
bad escape, use < and make sure you don't lose the space
| @@ -34,7 +34,7 @@ For each intent, it reference the applications that support that intent. | |||
| interface AppMetadata extends AppIdentifier { | |||
| /** | |||
| * The 'friendly' app name. This field was used with the `open` and | |||
| * `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` | |||
| * `raiseIntent` calls in FDC3\<2.0, which now require an `AppIdentifier` | |||
There was a problem hiding this comment.
bad escape, use < and make sure you don't lose the space
| @@ -1476,7 +1476,7 @@ Not implemented | |||
| </TabItem> | |||
| </Tabs> | |||
|
|
|||
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard <2.0. | |||
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard\<2.0. | |||
There was a problem hiding this comment.
Suggested change
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard\<2.0. | |
| Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard <2.0. |
| @@ -7,7 +7,7 @@ title: API Overview (next) | |||
| import Tabs from '@theme/Tabs'; | |||
| import TabItem from '@theme/TabItem'; | |||
|
|
|||
| The role of FDC3 API is to establish a baseline interface for interoperability between applications. Because FDC3 is largely an agreement between existing platforms and applications, standards should be optimized for ease of adoption rather than functional completeness. Functionality absent from a FDC3 specification is in no way a commentary on its importance. | |||
| The role of FDC3 API is to establish a baseline interface for interoperability between applications. Because FDC3 is largely an agreement between existing platforms and applications, standards should be optimized for ease of adoption rather than functional completeness. Functionality absent from a FDC3 specification is in no way a commentary on its importance. | |||
There was a problem hiding this comment.
why introduce a double space?
| - **RFC 5646**, _Tags for Identifying Languages, September 2009_, <https://datatracker.ietf.org/doc/html/rfc5646>. | ||
| - **TypeScript Programming Language**, <https://www.typescriptlang.org/>. | ||
| - **Web Application Manifest**, _W3C Working Draft_, February 2022 <https://www.w3.org/TR/appmanifest/> | ||
| - **Apache 2.0 open-source license**, https://www.apache.org/licenses/LICENSE-2.0 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0). |
There was a problem hiding this comment.
These changes are all creating double links, should be:
Suggested change
| - **Apache 2.0 open-source license**, https://www.apache.org/licenses/LICENSE-2.0 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0). | |
| - **Apache 2.0 open-source license**, [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0). |
| @@ -24,7 +24,7 @@ To create a new version of the website, a number of NPM scripts need to be run t | |||
|
|
|||
| 3. Check that the version script has done what it needs to: | |||
| - The new website version should exist in _website/versioned_docs_ | |||
| - Links to schema files should have been updated to the versioned links, e.g. check *website/versioned_docs/version-2.1/context/ref/Context.md* has a link like <https://fdc3.finos.org/schemas/2.1/context/context.schema.json> (where '2.1' would be 'next' in the pre-draft) | |||
| - Links to schema files should have been updated to the versioned links, e.g. check *website/versioned_docs/version-2.1/context/ref/Context.md* has a link like https://fdc3.finos.org/schemas/2.1/context/context.schema.json [https://fdc3.finos.org/schemas/2.1/context/context.schema.json](https://fdc3.finos.org/schemas/2.1/context/context.schema.json) (where '2.1' would be 'next' in the pre-draft) | |||
There was a problem hiding this comment.
more double links
Suggested change
| - Links to schema files should have been updated to the versioned links, e.g. check *website/versioned_docs/version-2.1/context/ref/Context.md* has a link like https://fdc3.finos.org/schemas/2.1/context/context.schema.json [https://fdc3.finos.org/schemas/2.1/context/context.schema.json](https://fdc3.finos.org/schemas/2.1/context/context.schema.json) (where '2.1' would be 'next' in the pre-draft) | |
| - Links to schema files should have been updated to the versioned links, e.g. check *website/versioned_docs/version-2.1/context/ref/Context.md* has a link like [https://fdc3.finos.org/schemas/2.1/context/context.schema.json](https://fdc3.finos.org/schemas/2.1/context/context.schema.json) (where '2.1' would be 'next' in the pre-draft) |
|
superseded by #1418 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)