tauri-docs icon indicating copy to clipboard operation
tauri-docs copied to clipboard

Add guide on Sidecar (Embedding External Binaries)

Open gsidhu opened this issue 2 years ago • 6 comments

What kind of changes does this PR include?

  • New or updated content

Description

  • Adds a guide on embedding external binaries (sidecar). Written based on the v1 guide.

Context This conversation with @vasfvitor on Discord

gsidhu avatar Apr 02 '24 08:04 gsidhu

Deploy Preview for tauri-v2 ready!

Built without sensitive environment variables

Name Link
Latest commit ea39af79f7683de0500617a867a74bbec2ed5b93
Latest deploy log https://app.netlify.com/sites/tauri-v2/deploys/66326dfbf47fe000083d7bc4
Deploy Preview https://deploy-preview-2017--tauri-v2.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

netlify[bot] avatar Apr 02 '24 08:04 netlify[bot]

Thanks for the comments. I'll resolve them.

For sidecar.md, I adapted the structure from the v1 guide. So maybe that's why it doesn't look too different?

As for the migration note I wrote on Discord, I wasn't sure if a new heading was needed for it on the migration page. All the points I mentioned there were already covered under other headings. Plus, if anyone were to compare the v1 guide with the v2 one I wrote, they could easily see what the changes were. (Mainly the change of module names + removal of allowlist)

What do you suggest?

gsidhu avatar Apr 03 '24 19:04 gsidhu

Plus, if anyone were to compare the v1 guide with the v2 one I wrote, they could easily see what the changes were. (Mainly the change of module names + removal of allowlist)

Yeah, I was gonna check this and analyze the changes.

All the points I mentioned there were already covered under other headings

I think, if you will, you can create a new heading in 'from-v1' to specifically address sidecar migration, there's no metion of it in the migrate guide

vasfvitor avatar Apr 03 '24 21:04 vasfvitor

Hi @vasfvitor, I finally got around to resolving your comments. I have made the changes in my fork. Should I make a new PR with it? Or is there a way I can add it to this existing PR... I am not too well-versed with this!

I think, if you will, you can create a new heading in 'from-v1' to specifically address sidecar migration, there's no metion of it in the migrate guide

Yep, done. Added a new section to the migration guide.

gsidhu avatar Apr 22 '24 08:04 gsidhu

Or is there a way I can add it to this existing PR... I am not too well-versed with this!

Just to help ya out. You made a fork and only copied the 'next' branch (default GitHub behavior) https://github.com/gsidhu/tauri-docs/branches, and you are making commits to that branch.

If you look at this PR subheading you'll notice that it's from your fork in the next branch into tauri-apps:next

image

So every change you add to your next branch, will reflect on this PR while it's not merged image

Lastly I want to add that it's usually a good idea that you create branches in your own fork so that you can always have multiple PR with separated changes, if needed. I hope this makes sense. So to answer your question, no, the changes are already here

Hi @vasfvitor, I finally got around to resolving your comments.

Thanks, I'll check it out

vasfvitor avatar Apr 22 '24 15:04 vasfvitor

just a heads up. Recently there was a major overhaul on the docs structure, so there are merge conflicts because content changed place/directory, if you need help resolving them tag me.

vasfvitor avatar Apr 23 '24 22:04 vasfvitor

I'll do another round on the sidecar.mdx file later. But on the migration page, isn't there any specific tauri.conf.json field that changed from v1 and need to be updated? Or the same config will work?

I don't think anything changed there.

just a heads up. Recently there was a major overhaul on the docs structure, so there are merge conflicts because content changed place/directory, if you need help resolving them tag me.

Figuring it out! Will keep you posted.

gsidhu avatar May 01 '24 10:05 gsidhu

Okay. I have no clue what I have done... Jeez, did not realise this was going to be this hard.

Is it a good idea to just close this pull request, create a new fork, and make a new PR?

gsidhu avatar May 01 '24 10:05 gsidhu

you did nothing wrong, the hard part wasn't your fault at all if that's related to the docs reestructure, I'll see if I can get from here

vasfvitor avatar May 01 '24 15:05 vasfvitor

@gsidhu yeah, better just to close this and open a new one, tag me then, I'll try to merge asap and get done with it. Everything looks fine.

vasfvitor avatar May 01 '24 16:05 vasfvitor

thanks for your efforts btw, I'm sorry this happened

vasfvitor avatar May 01 '24 16:05 vasfvitor

@gsidhu nevermind, I got it to work :) phew

vasfvitor avatar May 01 '24 16:05 vasfvitor

Oh wow. I have no idea how you've done this but thank you!!

You've made it a lot easier for someone like me to contribute to open source. :)

gsidhu avatar May 01 '24 16:05 gsidhu