Skip to content

Commit be9a46f

Browse files
Merge #1120
1120: Change the repo's name and purpose r=bidoubiwa a=bidoubiwa In order to move this repository from a repository only hosting `instant-meilisearch` to a repository containing multiple plugins that share some code, some steps must be fulfilled: - [x] Change the root README.md - [ ] Change the repo's name - [x] Change the URL's pointing to this repository in the following places: - [x] meilisearch-vue: meilisearch/meilisearch-vue#127 - [x] meilisearch-react: meilisearch/meilisearch-react#40 - [x] meilisearch-angular: meilisearch/meilisearch-angular#16 - [x] integration-guides: meilisearch/integration-guides#271 - [x] Meilisearch documentation meilisearch/documentation#2444 - [x] integration automation https://github.com/meilisearch/integration-automations/pull/154 - [ ] Meilisearch blog posts - [x] strapi plugin: meilisearch/strapi-plugin-meilisearch#722 - [ ] Mention the SDK in: - [x] integration guides: meilisearch/integration-guides#272 - [x] documentation meilisearch/documentation#2444 - [x] Change links inside the package.json of all packages and playgrounds Co-authored-by: Charlotte Vermandel <[email protected]> Co-authored-by: cvermand <[email protected]>
2 parents 0868fd2 + bd6a143 commit be9a46f

File tree

8 files changed

+44
-1059
lines changed

8 files changed

+44
-1059
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
1616

1717
## How to Contribute
1818

19-
1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/meilisearch/instant-meilisearch/issues/) or [open a new one](https://github.com/meilisearch/instant-meilisearch/issues/new).
19+
1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/meilisearch/meilisearch-js-plugins/issues/) or [open a new one](https://github.com/meilisearch/meilisearch-js-plugins/issues/new).
2020
2. Once done, [fork the instant-meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
2121
3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
2222
4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository.
2323
5. Make the changes on your branch.
2424
6. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main instant-meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
25-
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/instant-meilisearch/releases/).
25+
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/meilisearch-js-plugins/releases/).
2626

2727
## Development Workflow
2828

@@ -139,7 +139,7 @@ Some notes on GitHub PRs:
139139
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
140140
- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
141141
- All PRs must be reviewed and approved by at least one maintainer.
142-
- The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/instant-meilisearch/releases/).
142+
- The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-js-plugins/releases/).
143143

144144
## Release Process (for the internal team only)
145145

README.md

Lines changed: 23 additions & 1041 deletions
Large diffs are not rendered by default.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"license": "MIT",
55
"repository": {
66
"type": "git",
7-
"url": "https://github.com/meilisearch/instant-meilisearch.git"
7+
"url": "https://github.com/meilisearch/meilisearch-js-plugins.git"
88
},
99
"workspaces": [
1010
"packages/*",

packages/autocomplete-client/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
<p align="center">
1717
<a href="https://www.npmjs.com/package/@meilisearch/autocomplete-client"><img src="https://img.shields.io/npm/v/@meilisearch/autocomplete-client.svg" alt="npm version"></a>
18-
<a href="https://github.com/meilisearch/instant-meilisearch/actions"><img src="https://github.com/meilisearch/instant-meilisearch/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
19-
<a href="https://github.com/meilisearch/instant-meilisearch/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
18+
<a href="https://github.com/meilisearch/meilisearch-js-plugins/actions"><img src="https://github.com/meilisearch/meilisearch-js-plugins/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
19+
<a href="https://github.com/meilisearch/meilisearch-js-plugins/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
2020
<a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
2121
<a href="https://ms-bors.herokuapp.com/repositories/48"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2222
</p>
@@ -245,7 +245,7 @@ Some `autocomplete` parameters are not working using the meilisearch autocomplet
245245

246246
**Supported Meilisearch versions**:
247247

248-
This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/instant-meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
248+
This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-js-plugins/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
249249

250250
**Node / NPM versions**:
251251

packages/autocomplete-client/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": "0.2.1",
44
"private": false,
55
"description": "The search client to use Meilisearch with autocomplete.js.",
6-
"homepage": "https://github.com/meilisearch/instant-meilisearch/tree/main/packages/autocomplete-client",
6+
"homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/autocomplete-client",
77
"publishConfig": {
88
"access": "public"
99
},
@@ -28,7 +28,7 @@
2828
"types": "./dist/types/index.d.ts",
2929
"sideEffects": false,
3030
"bugs": {
31-
"url": "https://github.com/meilisearch/instant-meilisearch/issues"
31+
"url": "https://github.com/meilisearch/meilisearch-js-plugins/issues"
3232
},
3333
"files": [
3434
"dist",
@@ -44,7 +44,7 @@
4444
"license": "MIT",
4545
"repository": {
4646
"type": "git",
47-
"url": "https://github.com/meilisearch/instant-meilisearch.git"
47+
"url": "https://github.com/meilisearch/meilisearch-js-plugins.git"
4848
},
4949
"dependencies": {
5050
"@meilisearch/instant-meilisearch": "*"

packages/instant-meilisearch/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116

117117
This is the conventional way of calculating the facet distribution. Similar to Algolia's behavior. If you prefer the old behavior, please consider opening an issue.
118118

119-
See [complete explanation here](https://github.com/meilisearch/instant-meilisearch/issues/884)
119+
See [complete explanation here](https://github.com/meilisearch/meilisearch-js-plugins/issues/884)
120120

121121
- 72de4c8: - Compatibility with the `Index` widget is added.
122122

packages/instant-meilisearch/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
<p align="center">
1717
<a href="https://www.npmjs.com/package/@meilisearch/instant-meilisearch"><img src="https://img.shields.io/npm/v/@meilisearch/instant-meilisearch.svg" alt="npm version"></a>
18-
<a href="https://github.com/meilisearch/instant-meilisearch/actions"><img src="https://github.com/meilisearch/instant-meilisearch/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
19-
<a href="https://github.com/meilisearch/instant-meilisearch/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
18+
<a href="https://github.com/meilisearch/meilisearch-js-plugins/actions"><img src="https://github.com/meilisearch/meilisearch-js-plugins/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
19+
<a href="https://github.com/meilisearch/meilisearch-js-plugins/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
2020
<a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
2121
<a href="https://ms-bors.herokuapp.com/repositories/48"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2222
</p>
@@ -419,7 +419,7 @@ instantsearch.widgets.searchBox({
419419
The `configure` widget lets you provide raw search parameters to the Algolia API without rendering anything.
420420

421421
Because these are the search parameters of AlgoliaSearch and not the InstantSearch parameters, some of them are ignored by InstantSearch.<br>
422-
Since we do not act as AlgoliaSearch on search parameters, detailed compatibility can be found in [this issue](https://github.com/meilisearch/instant-meilisearch/issues/389).<br>
422+
Since we do not act as AlgoliaSearch on search parameters, detailed compatibility can be found in [this issue](https://github.com/meilisearch/meilisearch-js-plugins/issues/389).<br>
423423
This component should only be used if no other component provides the same configuration.
424424

425425
We also suggest looking at [Meilisearch's search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) to determine how they act.
@@ -468,7 +468,7 @@ The `voiceSearch` widget lets the user perform a voice-based query.
468468

469469
Search Insights lets you report click, conversion and view metrics.
470470

471-
More details about the subject are [given in this issue](https://github.com/meilisearch/instant-meilisearch/issues/410).
471+
More details about the subject are [given in this issue](https://github.com/meilisearch/meilisearch-js-plugins/issues/410).
472472

473473
Requires InstantSearch v4.8.3 or later.
474474

packages/instant-meilisearch/package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,15 @@
33
"version": "0.13.2",
44
"private": false,
55
"description": "The search client to use Meilisearch with InstantSearch.",
6-
"homepage": "https://github.com/meilisearch/instant-meilisearch",
6+
"homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch",
77
"license": "MIT",
88
"bugs": {
9-
"url": "https://github.com/meilisearch/instant-meilisearch/issues"
9+
"url": "https://github.com/meilisearch/meilisearch-js-plugins/issues"
10+
},
11+
"repository": {
12+
"type": "git",
13+
"url": "https://github.com/meilisearch/meilisearch-js-plugins.git"
1014
},
11-
"repository": "https://github.com/meilisearch/instant-meilisearch/tree/main/packages/instant-meilisearch",
1215
"publishConfig": {
1316
"access": "public"
1417
},

0 commit comments

Comments
 (0)