WIP: Adding .NET signatures to FDC3 documentation

kriswest commented 7 months ago

resolve #931

Changes:

Adds tabs throughout API spec for .NET signatures,
Moves supported platforms and API access content under API section

Reveiw notes:

Ensure a Changelog entry is added before merging
Needs a vote of the SWG before merging

netlify[bot] commented 7 months ago

Deploy Preview for fdc3 ready!

Name	Link
Latest commit	18812cc44aaee4574159b3a790cfbfcf45e12efb
Latest deploy log	https://app.netlify.com/sites/fdc3/deploys/6682e4ad4c9c330008e5f97d
Deploy Preview	https://deploy-preview-1108--fdc3.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 configuration.

kriswest commented 7 months ago

@bingenito @robmoffat my meeting was cancelled so I got this out of the way. I've added tabs for .NET signatures and examples throughout the docs (although just noticed I missed some in the spec page, will fix). The .NET tabs all currently contain the content TBC. If you don't want to translate the examples we can always delete their tabs and stick with TS only, or we can encourage other contributors to take those on.

I've also migrated the JS/TS specific API access content under 'supported platforms' (clearing up some duplicated content along the way) and moved that page under the API section (as that's what it actually relates to) - I haven't prepped anything for .NET on that page as yet.

I also haven't touched the context pages as yet - we want to move to something generated from the schemas so I don't think that worth the effort - doing so will change the example from TypeScript to JSON. If we do something for .NET there I'd suggest we do it in the Context overview (as that will remain and won't be generated from schemas): https://fdc3.finos.org/docs/next/context/spec

To work on this, check out the branch then run the following in your terminal from the directory:

cd website
npm install
npm run start

That'll build it and open a browser window with a preview. Note you'll see the current version by default, to see your changes use the version menu at the top left to select the 'next' version of the spec (or use the local deep link below). The preview will update whenever you save - I suggest saving often as you'll find out if you broke the page 😉

Local deep link: http://localhost:3000/docs/next/api/ref/DesktopAgent Preview deep link: https://deploy-preview-1108--fdc3.netlify.app/docs/next/api/spec

bingenito commented 7 months ago

@kriswest Confirmed I can see your changes in local hosted site. We will need to add support for csharp to the docusaurus config (it isn't on by default).

bingenito commented 7 months ago

Here we go. I think you can close this PR if you want and we can continue working on this branch in tandem to create eventual PR.

kriswest commented 7 months ago

@bingenito I converted this to a draft PR for now - I find the diffs and preview they provide useful and it gives us a thread to discuss as we go ;-)

Did you push your change to the docusaurus config?

bingenito commented 7 months ago

@kriswest I don't have permission to push to this branch. Do you want me to do my contribution through a PR to this branch and then we PR to master for group review?

kriswest commented 7 months ago

@kriswest I don't have permission to push to this branch. Do you want me to do my contribution through a PR to this branch and then we PR to master for group review?

@robmoffat @maoo now that we've got branch protection rules in place for the master branch of the FDC3 repo, is it possible to give push rights to the fdc3-participants team (which Brian is in) to facilitate collaboration by participants on PRs like this?

If not, do we need to use a fork that we both have rights to achieve the same thing elsewhere and/or PR into this branch from a fork? Please advise on best practice :-) The final alternative is that we get Brian appointed as a maintainer (which we propose to do anyway with the .NET contribution) - although I'm sure this will come up again with others (and we'll follow whatever procedure you advise/require).

maoo commented 7 months ago

Hi @kriswest !

The general best practice is to fork, invite, collaborate and submit PR, as both you and @bingenito suggested.

That said, given that Brian wrote the .net client, and is willing to collaborate and maintain this part of code, I believe he's a candidate to become an FDC3 maintainer. As FDC3 lead maintainer, you have the authority (and rights, via https://github.com/orgs/finos/teams/fdc3-maintainers) to make it happen, assuming other maintainers are ok with it.

linux-foundation-easycla[bot] commented 7 months ago

The committers listed above are authorized under a signed CLA.

:white_check_mark: login: kriswest / name: Kris West (edd07409c2af7ac2b41bc528f9d47a3a31cb54b7, ed677401a24f3c7ffa3ad96d690678982943fc98, 65aca0b30fa2879fab176792b2b7ee6fd8ccefaf, d011cf6d674f125dec0bbe58fd4f82e64feecbe9, 18812cc44aaee4574159b3a790cfbfcf45e12efb, f5e270ca93eb40b0574aed44131893f45d54ae15)
:white_check_mark: login: bingenito / name: Brian Ingenito (642980c7c043709f43f2292dfa899d1752b6c2e3, 045224a7ebf17a5b3fcc5667f7837b523200e550, 374eece8a9f1ba2c6621d79902658e78886b4eda, 4431206a4334e1d73bd6d9bcd44c35d4d35eb3e0, 18eaf13db4a09934985a1e00afb4d5dfb7a4c9d6, 9e314fd1c4855e3ed56f66714430f8a1c767b6f7, cd4d755b7914b5b7e7d448c59cdc4b8dc8b0fcf1, bbd1af5c6db784a86b5d523e9144ccc834007a98)

kriswest commented 6 months ago

/easycla

finos / FDC3