feat: add upgrade guide #1340
feat: add upgrade guide #1340
Conversation
✅ Deploy Preview for tauri-docs-starlight ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Includes some changes not yet available but I wanted to get this out ASAP. Also the guide assumes v2 stable is already out and the install instructions does not take the alpha in consideration. |
|
Oh this is amazing! I'll take a look at it later this week and do a copy pass |
Signed-off-by: Lorenzo Lewis <[email protected]>
Signed-off-by: Lorenzo Lewis <[email protected]>
Signed-off-by: Lorenzo Lewis <[email protected]>
|
Started working on this one. Overall love the detail, just trying to group the information a bit more and make it easy to link to specific migration sections. Could you take a look at this one I reworked and let me know if it's okay: https://deploy-preview-1340--tauri-docs-starlight.netlify.app/2/guide/upgrade-migrate/from-tauri-1/#migrate-to-cli-plugin I'll wait for feedback before I de-dup and re-work the sections below that. @FabianLars @simonhyll any feedback on any improvements we could make to make migration easier? |
Not yet, nope. Looks good so far :) |
Signed-off-by: Lorenzo Lewis <[email protected]>
Signed-off-by: Lorenzo Lewis <[email protected]>
There was a problem hiding this comment.
Sorry for taking a while on this one, it was a long (but very good) one. Put in a few comments just to fill in a few missing pieces and then I think should be good to merge.
Excited on this one because we should be able to easily add to this for different scenarios as we get feedback for any rough spots.
|
|
||
| ### Migrate to App Plugin | ||
|
|
||
| {/* TODO: Is the Tauri 1.0 Rust equivalent something like tauri::window::Window::hide? */} |
There was a problem hiding this comment.
Is the Tauri 1.0 Rust equivalent something like tauri::window::Window::hide (so we can list it here like the rest of the migration sections).
There was a problem hiding this comment.
The Rust equivalent wasn't changed.
| </TabItem> | ||
| <TabItem label="Rust"> | ||
|
|
||
| {/* TODO: Rust example */} |
| </TabItem> | ||
| <TabItem label="Rust"> | ||
|
|
||
| {/* TODO: Code example of this one? */} |
There was a problem hiding this comment.
Any example for this one? This one only initialises the plugin
| </TabItem> | ||
| <TabItem label="Rust"> | ||
|
|
||
| {/* TODO: Code example on the Rust side */} |
| </TabItem> | ||
| <TabItem label="Rust"> | ||
|
|
||
| {/* TODO: Rust example */} |
| </TabItem> | ||
| <TabItem label="Rust"> | ||
|
|
||
| {/* TODO: Rust example */} |
There was a problem hiding this comment.
Any example for this one? Should I copy-paste from the shell example?
| </TabItem> | ||
| <TabItem label="Rust"> | ||
|
|
||
| {/* TODO: Does this one need to be this complicated or could we simplify it to be similar to the other Rust code blocks? */} |
There was a problem hiding this comment.
Could this example be simplified to cover the most common use case or best example? Or is this a more involved migration that we need to keep this in on?
| </TabItem> | ||
| <TabItem label="Rust"> | ||
|
|
||
| {/* TODO: Rust example */} |
Signed-off-by: GitHub <[email protected]>
There was a problem hiding this comment.
Absolutely amazing! Thank you @lucasfernog
I just tweaked the overall page to be called "Upgrading", but still referring to some of actions (like moving towards a plugin) a "migration". Potato/potato, but upgrading felt like the more appropriate word for the overall guide to me.
* feat: add upgrade guide * update paragraph Signed-off-by: Lorenzo Lewis <[email protected]> * lots of updates Signed-off-by: Lorenzo Lewis <[email protected]> * refactors Signed-off-by: Lorenzo Lewis <[email protected]> * add link to migrate cli command Signed-off-by: Lorenzo Lewis <[email protected]> * add examples * change high-level phrasing to upgrade Signed-off-by: GitHub <[email protected]> --------- Signed-off-by: Lorenzo Lewis <[email protected]> Signed-off-by: GitHub <[email protected]> Co-authored-by: Lorenzo Lewis <[email protected]>
* feat: add upgrade guide * update paragraph Signed-off-by: Lorenzo Lewis <[email protected]> * lots of updates Signed-off-by: Lorenzo Lewis <[email protected]> * refactors Signed-off-by: Lorenzo Lewis <[email protected]> * add link to migrate cli command Signed-off-by: Lorenzo Lewis <[email protected]> * add examples * change high-level phrasing to upgrade Signed-off-by: GitHub <[email protected]> --------- Signed-off-by: Lorenzo Lewis <[email protected]> Signed-off-by: GitHub <[email protected]> Co-authored-by: Lorenzo Lewis <[email protected]>
* feat: add upgrade guide * update paragraph Signed-off-by: Lorenzo Lewis <[email protected]> * lots of updates Signed-off-by: Lorenzo Lewis <[email protected]> * refactors Signed-off-by: Lorenzo Lewis <[email protected]> * add link to migrate cli command Signed-off-by: Lorenzo Lewis <[email protected]> * add examples * change high-level phrasing to upgrade Signed-off-by: GitHub <[email protected]> --------- Signed-off-by: Lorenzo Lewis <[email protected]> Signed-off-by: GitHub <[email protected]> Co-authored-by: Lorenzo Lewis <[email protected]>
* feat: add upgrade guide * update paragraph Signed-off-by: Lorenzo Lewis <[email protected]> * lots of updates Signed-off-by: Lorenzo Lewis <[email protected]> * refactors Signed-off-by: Lorenzo Lewis <[email protected]> * add link to migrate cli command Signed-off-by: Lorenzo Lewis <[email protected]> * add examples * change high-level phrasing to upgrade Signed-off-by: GitHub <[email protected]> --------- Signed-off-by: Lorenzo Lewis <[email protected]> Signed-off-by: GitHub <[email protected]> Co-authored-by: Lorenzo Lewis <[email protected]>
No description provided.