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

Index settings tutorials #2711

Merged
merged 7 commits into from
Mar 14, 2024
Merged

Index settings tutorials #2711

merged 7 commits into from
Mar 14, 2024

Conversation

guimachiavelli
Copy link
Member

@guimachiavelli guimachiavelli commented Feb 8, 2024

Closes #2634.

Instead of the two options listed in the issue, I have opted for creating a short tutorial using the Cloud interface. This solves the issue of documenting an increasing number of interface elements with almost identical usage.

Since many users will prefer to use the API instead of the interface, this guide also adds a second tutorial teaching users to do the exact same thing with the API.

Notes for reviewers

  • @Strift: as usual, all feedback is welcome, but if you're short on time my main request is that you take a look at the fathom URL params and see if they align with how dev rel is handling them.

@meili-bot
Copy link
Collaborator

How to see the preview of this PR?

⚠️ Private link, only accessible to Meilisearch employees.

Go to this URL: https://website-git-deploy-preview-mei-16-meili.vercel.app/docs/branch:cloud-index-settings

Credentials to access the page are in the company's password manager as "Docs deploy preview".

@guimachiavelli guimachiavelli marked this pull request as ready for review February 13, 2024 12:20
Copy link
Contributor

@Strift Strift left a comment

Choose a reason for hiding this comment

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

The UTMs parameters are correct. 👌

You can add in the UTM tracking sheet to document it.

Regarding the content, I think we should not encourage API usage. The API should be seen as a fallback—a way to convey that Meili works with any stack.

Instead, I think we should demonstrate that Meilisearch integrates easily with our ICP stack via the following options:

  1. Via the UI (less tech work to do)
  2. Via the JavaScript SDK (target ecosystem n°1)
  3. Via the PHP SDK (target ecosystem n°2)
  4. Other options

I hope this helps!

@guimachiavelli
Copy link
Member Author

Thanks for the feedback, @Strift!

I'm interested on the product team feedback on this too, but for the moment I want to clarify a few things.

If I understand correctly, by API you mean curl, right? If that's the case, no need to worry. I left the code samples in code blocks so it's easier to see them in context, but once I get the ok from the technical reviewers I will move them to the code samples component and notify integrations we need new samples for JS and PHP (and potentially other SDKs, eventually). curl will remain available as an option because we still want users to follow along without having to set up a whole environment.

@Strift
Copy link
Contributor

Strift commented Feb 15, 2024

Great. I think we'll have to handle the code samples ourselves since there isn't an integration team anymore. :p

macraig
macraig previously approved these changes Feb 20, 2024
Copy link
Contributor

@macraig macraig left a comment

Choose a reason for hiding this comment

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

LGTM!

macraig
macraig previously approved these changes Feb 22, 2024
@guimachiavelli guimachiavelli merged commit ed645d7 into main Mar 14, 2024
1 check passed
@guimachiavelli guimachiavelli deleted the cloud-index-settings branch March 14, 2024 12:36
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.

Index settings in Meilisearch Cloud
5 participants