Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/merge Desktop/JS binding docs for tech review #3619

Closed
data-sync-user opened this issue Sep 30, 2020 · 8 comments
Closed

Update/merge Desktop/JS binding docs for tech review #3619

data-sync-user opened this issue Sep 30, 2020 · 8 comments
Assignees
Labels

Comments

@data-sync-user
Copy link
Collaborator

data-sync-user commented Sep 30, 2020

Existing docs updated, deprecated, linked and/or merged and ready for outside technical review of Desktop JS Bindings:

  • UniFFI theory of operations doc
    • link to Travis’ vendoring doc
    • link/borrow pieces of Android api doc for observer bits
  • ADR for UniFFI/Nimbus Firefox Desktop JS Bindings

The review and landings themselves will be tracked in other tickets, so some of the earlier comments here will be filed/tracked elsewhere..

┆Issue is synchronized with this Jira Task
┆Issue Number: SDK-19

@data-sync-user
Copy link
Collaborator Author

➤ Chelsea Lewis commented:

Leaving unassigned as this will be work done by an external team. Lina will keep track of this throughout the sprint.

@data-sync-user
Copy link
Collaborator Author

➤ Lina Cambridge commented:

The review packet so far:

@data-sync-user
Copy link
Collaborator Author

➤ Nicholas Nethercote commented:

I've looked over the three parts of the review packet. Overall it looks good. The C++ proposal is straightforward. The JS proposal is still gnarly but that is unavoidable. I put some additional comments are in the Google Docs and the PR.

@data-sync-user
Copy link
Collaborator Author

➤ Lina Cambridge commented:

Thanks, @nnethercote! To close this issue out, I think we'll want to:

  • Update the ADR to reflect that we're going with Option C for now. We can always revisit later.
  • Bring Add S3 storage for storing media files #255 up to date with Nick's feedback, and get it reviewed and landed.
  • Convert the Google Doc ADRs to Markdown, and move them into this repo.

After that's done:

@rfk
Copy link

rfk commented Nov 16, 2020

This is still open in our Jira, so re-opening here.

@rfk rfk reopened this Nov 16, 2020
@data-sync-user data-sync-user changed the title Technical review for generated Desktop bindings (JS and C++) Update/merge Desktop/JS binding docs for tech review Feb 19, 2021
@data-sync-user
Copy link
Collaborator Author

➤ Daniel Mosedale commented:

Here is the updated Theory of Operations doc, which I've sent out for review:

https://docs.google.com/document/d/1JnSruKgfKDcfIuiMirEIhum4NOWYlo58sCXPoxtC21g/edit#heading=h.gug06n5739a

@data-sync-user
Copy link
Collaborator Author

➤ Daniel Mosedale commented:

Updated version of the ADR doc is at

https://docs.google.com/document/d/1wIb2ZOXn2RI75-GvicuuYbsYS-nqBAqMJxmVaePE3Wg/edit?usp=sharing ( https://docs.google.com/document/d/1wIb2ZOXn2RI75-GvicuuYbsYS-nqBAqMJxmVaePE3Wg/edit?usp=sharing )

The main changes here are just that I've incorporate a bunch of useful comments on the original doc from suggestions into the doc itself.

@data-sync-user
Copy link
Collaborator Author

➤ Daniel Mosedale commented:

Because the changes to the ADR doc weren't substantive, I don't think getting further review on it at this is likely to be very useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants