docs: add migration guide page #449
Conversation
shortcuts
requested review from
eunjae-lee and
millotp
and removed request for
a team
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
| To get started, you first need to install `algoliasearch` (or any other available API client package). You can find the full list of available packages [here](https://www.npmjs.com/org/experimental-api-clients-automation). | ||
|
|
||
| All of our clients comes with type definition, and are available for both `browser` and `node` environments. |
There was a problem hiding this comment.
As our docs become bigger, is there a way to split those files per languages ? It's not urgent at all
There was a problem hiding this comment.
Yep it would make us duplicate content, however I think we could read the snippets from an external file and inject it here, since it's JS
There was a problem hiding this comment.
Since we know in the end that it will most likely live in the official doc I don't think we should dedicate time for that but it's definitely doable
@millotp If you check https://deploy-preview-449--api-clients-automation.netlify.app/docs/api-clients/installation/ it's also removed for dark mode, isn't it for you? |
|
In dark mode it's still in italic |
good after f5c1e2e |
|
|
||
| The amount of changes in this new version is significant. If you were using a version older than v4, please also read [this migration guide](https://www.algolia.com/doc/api-client/getting-started/upgrade-guides/javascript/) | ||
|
|
||
| **You should thoroughly test your application once the migration is over.** |
There was a problem hiding this comment.
Not sure if we need this line. It's kind of obvious. Also, it's not that we're providing any special tool or guide to test things 🤔
There was a problem hiding this comment.
Yep I agree it's not that mandatory, but I feel like it's still good to mention it so we don't get people saying their prod is broken after upgrade :D
|
|
||
| | Previous | Latest | Description | | ||
| | ----------- | :---------- | :------------------------------------------------- | | ||
| | `initIndex` | **removed** | All methods are now available at the client level. | |
There was a problem hiding this comment.
Do we have any example to work around this somewhere else? If not, we should add an example here, to actually explain what it means to them, and what they need to do to migrate.
edit: I just found "Methods targetting an indexName" section below. Should we add a link here to that section? Or just a very short example to give a brief idea?
There was a problem hiding this comment.
Ah yep indeed I'll link it!
| - import algoliasearch from 'algoliasearch/lite'; | ||
| + import { algoliasearchLiteClient } from '@experimental-api-clients-automation/algoliasearch-lite'; | ||
|
|
||
| - import algoliasearch from 'algoliasearch'; | ||
| + import { algoliasearch } from '@experimental-api-clients-automation/algoliasearch'; |
There was a problem hiding this comment.
Very readable with diff!
Btw, it's a side note, but it's a bit inconsistent to me that we have algoliasearch and algoliasearchLiteClient. The latter could simply be algoliasearchLite. What do you think?
There was a problem hiding this comment.
Yep definitely, the only thing is that since it's generated, it adds the Client automatically.
So either we make algoliasearch consistent, either we remove the Client suffix (for JS only?) I don't really like the latter
There was a problem hiding this comment.
Hah, I don't like the latter either! Let's leave it as-is, and think about it later :)
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-447
Changes included:
Adds the
migration guidepage to list the breaking changes and some more snippets.It's not as exhaustive as the Algolia doc, but it should come together after the
most frequent use casesare listed.🧪 Test
Netlify preview :D