Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new Meilisearch Cloud tutorial #2540

Merged
merged 5 commits into from
Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions config/sidebar-learn.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@
"label": "Quick start",
"slug": "quick_start"
},
{
"source": "learn/getting_started/cloud_quick_start.mdx",
"label": "Getting started with Meilisearch Cloud",
"slug": "cloud_quick_start"
},
{
"source": "learn/getting_started/search_preview.mdx",
"label": "Search preview",
Expand Down
11 changes: 10 additions & 1 deletion home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,16 @@ Learn how to use Meilisearch in your projects by exploring our guides and API re
{
content: (
<>
<Heading as="h2" style={{marginBottom: "-10px"}} noAnchor>Quick start</Heading> New here? Check out our quick start guide to learn how to set up Meilisearch, add data, and make your first search.
<Heading as="h2" style={{marginBottom: "-10px"}} noAnchor>Getting started with Meilisearch Cloud</Heading> New here? Check out our quick start guide to learn how to set up Meilisearch using our Cloud offering, import data, and make your first search.
</>
),
size: 4,
link: '/docs/learn/getting_started/cloud_quick_start'
},
{
content: (
<>
<Heading as="h2" style={{marginBottom: "-10px"}} noAnchor>Quick start</Heading> Prefer self-hosting? Take a look at our quick start guide and learn how to set up and use Meilisearch locally.
</>
),
size: 4,
Expand Down
77 changes: 77 additions & 0 deletions learn/getting_started/cloud_quick_start.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Getting started with Meilisearch Cloud

This tutorial walks you through setting up Meilisearch Cloud, creating a project and an index, adding documents to it, and performing your first search with the default web interface.

You need a Meilisearch Cloud account to follow along. If you don't have one, register for a 14-day free trial account at [https://cloud.meilisearch.com/register](https://cloud.meilisearch.com/register).

## Creating a project

To use Meilisearch Cloud, you must first create a project. Projects act as containers for indexes, tasks, billing, and other information related to Meilisearch Cloud.

Click the "New project" button on the top menu. If you have a free trial account and this is your first project, the button will read "Start free trial" instead:

![The Meilisearch Cloud menu, featuring the "New Project" button](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/1-new-project.png)

Name your project `meilisearch-quick-start` and select the region closest to you, then click on "Create project":

![A modal window with two mandatory fields: "Project name" and "Select a region"](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/2-create-project.png)

If you are not using a free trial account, you must also choose a billing plan based on the size of your dataset and number of searches per month:

![A variation of the previous modal window with an extra mandatory field: "Select a plan". There are four billing plan options, from cheapest to most expensive: "Build", "Grow", "Pro", and "Enterprise"](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/3-project-billing.png)

Creating your project might take a few minutes. Check the project list to follow its status. Once the project is ready, click on its name to go to the project overview page:

![Meilisearch Cloud's main list of projects. It features only one project, "meilisearch-quick-start", and shows information such as API keys, URL, and number of monthly searches](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/4-project-list.png)

## Creating an index and adding documents

After creating your project, you must index the data you want to search. Meilisearch stores and processes data you add to it in indexes. A single project may contain multiple indexes.

First, click on the indexes tab in the project page menu:

![The project overview page, featuring a secondary menu with several links. A red arrow points at a menu item: "Indexes"](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/5-project-page-menu-indexes.png)

This leads you to the index listing. Click on "Create an index":

![An empty list of indexes in this project with a button on the upper right corner](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/6-index-list-empty.png)

Write `movies` in the name field and click on "Create Index":

![A modal window with one mandatory field: "Index name"](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/7-create-index.png)

The final step in creating an index is to add data to it. Choose "File upload":

![Another modal window with three options. A red arrow points at the chosen option, "File upload"](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/8-file-upload.png)

Meilisearch Cloud will ask you for your dataset. To follow along with this tutorial, use this <ButtonLink as="a" id="downloadMovie" href="/movies.json" download="movies.json">list of movies</ButtonLink>. Download the file to your computer, drag and drop it into the specified area, then click on "Import documents":

![Another modal window with a large drag-and-drop area. It indicates a file named "movies.json" will be uploaded](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/9-data-import.png)

Meilisearch Cloud will index your documents. This may take a moment. Click on "See index list" and wait. Once it is done, click on "Settings" to visit the index overview:
guimachiavelli marked this conversation as resolved.
Show resolved Hide resolved

![A list of all indexes in this project. It shows a single index, `movies`, and indicates it contains over 30,000 documents](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/10-index-list-filled.png)

## Searching

With all data uploaded and processed, the last step is to run a few test searches to confirm Meilisearch is running as expected.

Click on the project name on the breadcrumb menu to return to the project overview:

![The index list page. A red arrow points at the breadcrumb menu](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/11-index-list-breadcrumb.png)

Meilisearch Cloud comes with a search preview interface. Click on "Search preview" to access it:

![The project overview page. A red arrow points at a menu item named "Search preview"](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/12-project-page-url.png)

Finally, try searching for a few movies, like "Solaris":

![The search preview interface, with "solaris" written in the search bar](https://raw.githubusercontent.com/meilisearch/documentation/cloud-quick-start/assets/images/cloud-getting-started/13-search-preview.png)

If you can see the results coming in as you type, congratulations: you now know all the basic steps to using Meilisearch Cloud.

## What's next

This tutorial taught you how to use Meilisearch Cloud's interface to create a project, add an index to it, and use the search preview interface.

In most real-life settings, you will be creating your own search interface and retrieving results through Meilisearch's API. To learn how to add documents and search using the command-line or an SDK in your preferred language, check out the [Meilisearch quick start](/learn/getting_started/quick_start).
2 changes: 2 additions & 0 deletions learn/getting_started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ chmod +x meilisearch

[Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=installation-guide) greatly simplifies installing, maintaining, and updating Meilisearch. [Get started with a 14-day free trial](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=installation-guide).

Take a look at our [Meilisearch Cloud tutorial](/learn/getting_started/cloud_quick_start) for more information on setting up and using Meilisearch's cloud service.

### Cloud deploy

To deploy Meilisearch on a cloud service, follow one of our dedicated guides:
Expand Down
4 changes: 4 additions & 0 deletions learn/getting_started/quick_start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ To follow this tutorial you need:
- A [command line terminal](https://www.learnenough.com/command-line-tutorial#sec-running_a_terminal)
- [cURL](https://curl.se)

<Capsule intent="tip">
Using Meilisearch Cloud? Check out the dedicated guide, [Getting started with Meilisearch Cloud](/learn/getting_started/cloud_quick_start).
</Capsule>

## Setup and installation

First, you need to download and install Meilisearch. This command installs the latest Meilisearch version in your local machine:
Expand Down