Skip to content

Adding more retriever examples to the documentation examples #116196

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 24 commits into from
Nov 11, 2024
Merged

Adding more retriever examples to the documentation examples #116196

merged 24 commits into from
Nov 11, 2024

Conversation

pmpailis
Copy link
Contributor

@pmpailis pmpailis commented Nov 4, 2024 •
edited
Loading

Adding more examples to document retriever usage and newly available functionality.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 4, 2024

Documentation preview:

@pmpailis pmpailis requested a review from leemthompo November 4, 2024 17:07
@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v9.0.0 labels Nov 4, 2024
@pmpailis pmpailis added >docs General docs changes auto-backport Automatically create backport pull requests when merged :Search Relevance/Search Catch all for Search Relevance v8.16.1 v8.17.0 and removed needs:triage Requires assignment of a team area label labels Nov 4, 2024
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch labels Nov 4, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-search-relevance (Team:Search Relevance)

leemthompo
leemthompo reviewed Nov 5, 2024
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Just some initial formatting fixes to pass CI and get URL preview generated :)

I'll do another pass tomorrow for copyediting, etc.

leemthompo
leemthompo reviewed Nov 6, 2024
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Some copyedits for consistency and simple phrasing where possible. Also tries to remove statements like "Now you can do x" because this will become stale fast.

I'd like for some dev peers to take a look at this PR too for technical feedback :)

@pmpailis
Copy link
Contributor Author

pmpailis commented Nov 6, 2024

Thank you a lot for the feedback and suggestions @leemthompo 🙏

carlosdelest
carlosdelest approved these changes Nov 7, 2024
View reviewed changes
Copy link
Member

@carlosdelest carlosdelest left a comment

Choose a reason for hiding this comment

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

Nice work Panos - The examples are comprehensive and well thought 💯

Some notes on the overall tone and the ordering - but it could be just me 😅

@leemthompo
Copy link
Contributor

@pmpailis @carlosdelest I wonder if it would be cleaner if these examples lived on a subpage to the retrievers overview? I think they might merit their own page.

@pmpailis
Copy link
Contributor Author

pmpailis commented Nov 8, 2024

@pmpailis @carlosdelest I wonder if it would be cleaner if these examples lived on a subpage to the retrievers overview? I think they might merit their own page.

++ that's a nice idea. Tbf the retrievers overview page is getting pretty hard to navigate with the all the additional content.

@pmpailis
Copy link
Contributor Author

pmpailis commented Nov 8, 2024

@elasticmachine update branch

@elasticmachine
Copy link
Collaborator

There are no new commits on the base branch.

leemthompo
leemthompo reviewed Nov 8, 2024
View reviewed changes
leemthompo
leemthompo approved these changes Nov 11, 2024
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for iterating. I've left a couple minor suggestions, plus a note about testing that can be done in a follow-up. 👍

@pmpailis pmpailis merged commit 64c362b into elastic:main Nov 11, 2024
5 checks passed
@pmpailis pmpailis mentioned this pull request Nov 11, 2024
Merged
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
❌ 8.16 Commit could not be cherrypicked due to conflicts
✅ 8.x

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 116196

pmpailis added a commit to pmpailis/elasticsearch that referenced this pull request Nov 11, 2024
@pmpailis
Adding more retriever examples to documentation (elastic#116196)
96f83a7
elasticsearchmachine pushed a commit that referenced this pull request Nov 11, 2024
@pmpailis
Adding more retriever examples to documentation (#116196) (#116579)
46acd4d
@pmpailis pmpailis mentioned this pull request Nov 11, 2024
Merged
@pmpailis pmpailis mentioned this pull request Nov 12, 2024
Merged
jozala pushed a commit that referenced this pull request Nov 13, 2024
@pmpailis @jozala
Adding more retriever examples to documentation (#116196)
00c9cfd
afoucret pushed a commit to afoucret/elasticsearch that referenced this pull request Nov 14, 2024
@pmpailis @afoucret
Adding more retriever examples to documentation (elastic#116196)
51a6d12
alexey-ivanov-es pushed a commit to alexey-ivanov-es/elasticsearch that referenced this pull request Nov 28, 2024
@pmpailis @alexey-ivanov-es
Adding more retriever examples to documentation (elastic#116196)
38747b5
@pmpailis pmpailis deleted the docs_add_more_retriever_examples branch May 27, 2025 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@carlosdelest carlosdelest carlosdelest approved these changes

@leemthompo leemthompo leemthompo approved these changes

Assignees

No one assigned

Labels

auto-backport Automatically create backport pull requests when merged >docs General docs changes :Search Relevance/Search Catch all for Search Relevance Team:Docs Meta label for docs team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch v8.16.1 v8.17.0 v9.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@pmpailis @elasticsearchmachine @leemthompo @carlosdelest @elasticmachine