Adding .NET signatures to FDC3 documentation #1108
Conversation
…platforms and API access content under API
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@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 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 startThat'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 |
|
@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).
|
|
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.
|
|
@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? |
|
@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 :-) |
|
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. |
|
|
|
/easycla |
kriswest
changed the title
|
Added a changelog entry and changed this PR to ready to review as I think it is @bingenito. It'll need a review from @hughtroeger and perhaps another member of @finos/fdc3-maintainers. |
|
@bingenito you were a contributor to this PR but are currently not the last push if you want to add a review yourself. |
|
Thanks @bingenito - we just need @hughtroeger's blessing in that case ;-) |
|
@kriswest Should globals.md be showing as deleted? |
Looks like it was in the very first commit with the creation of supported platforms. I guess I didn't notice that content was moved. |
|
Yes, it's only relevant to web so it made sense to move to supported-platforms. fdc3-for-the-web will replace the recommendation with using getAgent() anyway, so its reworked further in that PR. |
| /// <summary> | ||
| /// Returned if the specified channel is not found when attempting to join a | ||
| /// channel via the `JoinUserChannel` function of the DesktopAgent. | ||
| /// </summary> |
There was a problem hiding this comment.
These summary tags don't seem to render on the docs site. Are they supposed to apply formatting?
There was a problem hiding this comment.
I think thats all the formatting they get in prism - as a comment block.
There was a problem hiding this comment.
c# doc syntax for intellisense and if you were to do doc generation. I copied and pasted directly from the source and did not delete commments.
|
🎉 we (well @bingenito) got there! Merging... |
resolve #931
Changes:
Reveiw notes: