Add migration guide for #2598 #2647
Conversation
| The `login` function, as imported from `wasp/client/auth`, has changed | ||
| the way of calling it: | ||
|
|
||
| - ❌ **OLD**: `login(usernameValue, passwordValue)` |
There was a problem hiding this comment.
For this kind of before/after code blocks, we usually use tabs like this: https://github.com/wasp-lang/wasp/blob/release/web/docs/migration-guides/migrate-from-0-14-to-0-15.md?plain=1#L68
| ### The `login` function from `wasp/client/auth` has changed parameters | ||
|
|
||
| :::note | ||
| Only if you are using [username and password authentication](../auth/username-and-pass.md). |
There was a problem hiding this comment.
This sentence doesn't feel like a standalone sentence, I'd expand it to say smth like "This change only affects you if you are using the username & password auth. If you are using the email auth, you are fine."
There was a problem hiding this comment.
I modified it but now I feel it's a bit verbose.
| Only if you are using [username and password authentication](../auth/username-and-pass.md). | ||
| ::: | ||
|
|
||
| If you were using the `login` function (imported from `wasp/client/auth`), |
There was a problem hiding this comment.
I'd use the Before/After tabs here as well.
|
|
||
| ## What's new in 0.17.0? | ||
|
|
||
| ### The `login` function from `wasp/client/auth` has changed parameters |
There was a problem hiding this comment.
| ### The `login` function from `wasp/client/auth` has changed parameters | |
| ### The `login` function parameters changed (username & password only) |
I have the urge to add "username & password" to the title for people that will glance over the text below. You decide if it's too much.
|
@infomiho ready |
|
|
||
| ## What's new in 0.17.0? | ||
|
|
||
| ### The `login` function parameters changed (username & password only) |
There was a problem hiding this comment.
When I looked at the rendered docs, this title looks less aesthetically pleasing with the (username & password only) bit. But that's just me nitpicking :D
There was a problem hiding this comment.
but then how do you want it? 😂 i roll it back to before your suggestion?
Description
Adds a migration guide for #2598, (as started by @FranjoMindek in #2625).
Select what type of change this PR introduces: