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 how to run MeiliSearch in README #13

Merged
merged 4 commits into from
Apr 18, 2020
Merged

Add how to run MeiliSearch in README #13

merged 4 commits into from
Apr 18, 2020

Conversation

curquiza
Copy link
Member

@curquiza curquiza commented Apr 17, 2020

Add precision in the readme about how to run a MeiliSearch instance (a crucial part to get the scraper worked ^^)

I add you as reviewers because it's a part I will add in the README of docs-searchbar.js and vuepress-plugin too

@curquiza curquiza requested review from eskombro and tpayet April 17, 2020 12:55
tpayet
tpayet previously approved these changes Apr 17, 2020

Here is the [documentation to install and run MeiliSearch](https://docs.meilisearch.com/guides/advanced_guides/installation.html#installation).

_A tutorial about how to run MeiliSearch in production is coming..._
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see what you did there 🙈

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So much pressure on you now

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming... :)

README.md Outdated Show resolved Hide resolved
Co-Authored-By: Thomas Payet <thomas@meilisearch.com>
README.md Outdated
@@ -2,7 +2,15 @@

A scraper for your documentation website that indexes the scraped content into a MeiliSearch instance.

[MeiliSearch](https://github.com/meilisearch/MeiliSearch) is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box

This scraper is used in production and crawls the [MeiliSearch documentation](https://docs.meilisearch.com/) on each deployment.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Crawler == Downloading the web pages?
Scraper == Analyzing/indexing?

Just want to be sure about terminology. Because both terms are used widely, and mixed in sentences. SO just want to be sure you are sure about how you use them :)

Copy link
Member Author

@curquiza curquiza Apr 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest I wrote that without thinking it could have a difference 😂
I found out this difference: https://www.skylynapps.com/scrapemate/learn/help/general/difference-between-crawler-and-scraper.php
Still not really clear haha
I'm going to update the docs then, to only use words I'm sure to know 😅


Here is the [documentation to install and run MeiliSearch](https://docs.meilisearch.com/guides/advanced_guides/installation.html#installation).

_A tutorial about how to run MeiliSearch in production is coming..._
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming... :)

eskombro
eskombro previously approved these changes Apr 17, 2020
@curquiza curquiza merged commit 32452e4 into master Apr 18, 2020
@curquiza curquiza deleted the readme branch April 18, 2020 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants