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

Move content out of learn/experimental section #2979

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

guimachiavelli
Copy link
Member

@guimachiavelli guimachiavelli commented Sep 11, 2024

@meilisearch/integration-team: this PR makes two types of changes to code samples:

  • add an experimental_ prefix to the following existing code sample ids, without any changes to the samples themselves:
    • get_embedders_1 -> experimental_get_embedders_1
    • update_embedders_1 -> experimental_update_embedders_1
    • reset_embedders_1 -> experimental_reset_embedders_1
    • search_parameter_guide_hybrid_1 -> experimental_search_parameter_guide_hybrid_1
    • search_parameter_guide_vector_1 -> experimental_search_parameter_guide_vector_1
    • search_parameter_reference_retrieve_vectors_1 -> experimental_search_parameter_reference_retrieve_vectors_1
  • adds a handful of new samples:
    • experimental_get_metrics_1
    • experimental_post_logs_stderr_1
    • experimental_post_logs_stream_1
    • experimental_delete_logs_stream_1

This change is mostly for my own internal organization. I do not expect you to supply code samples for any future samples prefixed with experimental_, except in strategic cases like AI-powered search.

@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:create-experimental-api-routes

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 September 23, 2024 10:47
@guimachiavelli guimachiavelli requested a review from a team as a code owner September 23, 2024 10:47
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

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

add an experimental_ prefix to the following existing code sample ids, without any changes to the samples themselves:

I have to say I'm not pro this change 😞

  • a lot of changes on our side to do
  • features can be stabilized in a future, and it will be the case of AI, so we will have to change it everywhere again...

Can't you manage your code samples without this change? 🙏 would definitely help us on our side.

@guimachiavelli
Copy link
Member Author

@macraig, in short, I'm moving everything out of the experimental section and into places users are more likely to find that info naturally (e.g. CONTAINS in the filter reference). If you have the time, I'd appreciate if you could give it a quick look just in case there's any info that's clearly out of date.

macraig
macraig previously approved these changes Oct 1, 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.

The new structure looks good to me!

Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

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

discussed with @guimachiavelli and I would rather we don't do this breaking due to the lot of work coming after this breaking for integrations

@macraig
Copy link
Contributor

macraig commented Oct 1, 2024

discussed with @guimachiavelli and I would rather we don't do this breaking due to the lot of work coming after this breaking for integrations

Oh my bad, as @guimachiavelli 's request for review was after your initial comment @curquiza , I thought you were ok with these changes.

@guimachiavelli
Copy link
Member Author

guimachiavelli commented Oct 2, 2024

Apologies, I should have clarified that I intended @macraig's review to be on the content of the PR itself so at least that part has been approved. I'll change the current code samples back to their previous state to reflect in a future commit, once I've dealt with other priorities.

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.

4 participants