Skip to content

Split retrievers docs #131385

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 14 commits into from
Jul 17, 2025
Merged

Split retrievers docs #131385

merged 14 commits into from
Jul 17, 2025
+1,065 −1,024

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Jul 16, 2025 •
edited
Loading

Closes https://github.com/elastic/developer-docs-team/issues/322

  • Break big page out into subpages
  • Redirects weren't working as expected, got there thanks to @cotti

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 17, 2025 •
edited
Loading

🔍 Preview links for changed docs

More links …

@leemthompo leemthompo changed the title Split retrievers docs WIP Split retrievers docs Jul 17, 2025
@leemthompo leemthompo marked this pull request as ready for review July 17, 2025 15:30
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Jul 17, 2025
@leemthompo leemthompo self-assigned this Jul 17, 2025
@leemthompo leemthompo added >docs General docs changes Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v9.1.0 labels Jul 17, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jul 17, 2025
kderusso
kderusso approved these changes Jul 17, 2025
View reviewed changes
Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for taking care of this @leemthompo ! I've left some non-blocking feedback.

docs/reference/elasticsearch/rest-apis/retrievers.md
Copy link
Member

Choose a reason for hiding this comment

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

For the most part, these retrievers are being added in the order in which they were developed, which isn't very helpful.

I'd like to suggest thinking about how we will organize this list long term as we continue to add new retrievers (for example break out standard vs compound retriever use cases), but in the meantime, perhaps we can order the retrievers in this list alphabetically? This would make it easier for users to scan for the particular retriever they're looking for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

makes sense, I ordered them alphabetically in the TOC also so I should be consistent :) 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

long term we'll document these in the spec hopefully but the current api docs frontend doesn't really showcase retrievers very well, but as you say that's a longer term consideration

Copy link
Contributor

Choose a reason for hiding this comment

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

++ for grouping retrievers by type in the future

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I mean I could maybe do this in this PR if we wanna get that ball rolling 🤷‍♂️

Lemme know what you think

Copy link
Member

Choose a reason for hiding this comment

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

I'd say merge as is for now and do any other reorganization as a followup - this is already a great change. Thanks!

Mikep86
Mikep86 approved these changes Jul 17, 2025
View reviewed changes
Copy link
Contributor

@Mikep86 Mikep86 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM! I'm not sure how redirects work in the docs, so I didn't review that part. Otherwise, I think @kderusso's comments cover it :)

docs/reference/elasticsearch/rest-apis/retrievers.md
Copy link
Contributor

Choose a reason for hiding this comment

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

++ for grouping retrievers by type in the future

kderusso
kderusso approved these changes Jul 17, 2025
View reviewed changes
docs/reference/elasticsearch/rest-apis/retrievers.md
Copy link
Member

Choose a reason for hiding this comment

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

I'd say merge as is for now and do any other reorganization as a followup - this is already a great change. Thanks!

@leemthompo leemthompo merged commit 56477d8 into elastic:main Jul 17, 2025
10 checks passed
@leemthompo leemthompo deleted the split-retrievers branch July 17, 2025 19:22
@leemthompo leemthompo mentioned this pull request Jul 17, 2025
Merged
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 9.1

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jul 17, 2025
@leemthompo
Split retrievers docs and redirect anchors (elastic#131385)
39bf63b
elasticsearchmachine pushed a commit that referenced this pull request Jul 17, 2025
@leemthompo
Split retrievers docs and redirect anchors (#131385) (#131475)
06d4baa
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mikep86 Mikep86 Mikep86 approved these changes

@kderusso kderusso kderusso approved these changes

@ioanatia ioanatia Awaiting requested review from ioanatia

Assignees

@leemthompo leemthompo

Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v9.1.0 v9.2.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@leemthompo @elasticsearchmachine @Mikep86 @kderusso