Skip to content

[DOCS] Rework semantic search main page #112452

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 11 commits into from
Sep 12, 2024
Merged

[DOCS] Rework semantic search main page #112452

merged 11 commits into from
Sep 12, 2024

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Sep 3, 2024 •
edited
Loading

Overview

This PR reworks and updates the semantic search main page.

  • Adds a new Choose a semantic search workflow section that describes the various ways users can use the Stack for semantic search and recommends the semantic text workflow
  • Adds a new Using the right query section that helps users understand which query should be used for the different vectors
  • Provides a table about the field types and the corresponding queries
  • Moves the deployed ELSER and dense vector model tutorial to a sub-page (content is unchanged)
  • Reorganize the sub-pages in TOC so the most important comes first
  • Improves read more list at the end of the main page

Preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 3, 2024

Documentation preview:

@szabosteve szabosteve marked this pull request as ready for review September 3, 2024 12:49
leemthompo
leemthompo reviewed Sep 4, 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.

This is looking good and is already super helpful for outlining the options! I have a few suggestions and ideas. :)

leemthompo
leemthompo reviewed Sep 4, 2024
View reviewed changes
leemthompo
leemthompo approved these changes Sep 4, 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.

This is going to be very helpful! 🎉

Few final little suggestions, and a question about whether we can make the table columns nicer.

@szabosteve szabosteve requested a review from Mikep86 September 4, 2024 14:41
@szabosteve szabosteve removed the WIP label Sep 5, 2024
@elasticsearchmachine
Copy link
Collaborator

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

Mikep86
Mikep86 reviewed Sep 11, 2024
View reviewed changes
Copy link
Contributor

@Mikep86 Mikep86 left a comment

Choose a reason for hiding this comment

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

Great work 🙌 ! I left some minor comments about wording and some more links.

@szabosteve
Copy link
Contributor Author

@Mikep86 Thank you for the review and the suggestions. I addressed all of them via 4e0a49e and 340926c.

@szabosteve szabosteve requested a review from Mikep86 September 12, 2024 08:43
Mikep86
Mikep86 approved these changes Sep 12, 2024
View reviewed changes
Copy link
Contributor

@Mikep86 Mikep86 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for your patience!

@szabosteve szabosteve merged commit a151bb0 into elastic:main Sep 12, 2024
5 checks passed
@szabosteve szabosteve deleted the rework-semantic-search-main branch September 12, 2024 12:09
szabosteve added a commit to szabosteve/elasticsearch that referenced this pull request Sep 12, 2024
@szabosteve @leemthompo @Mikep86
[DOCS] Rework semantic search main page (elastic#112452)
6c87de3 
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Mike Pellegrini <[email protected]>
@szabosteve szabosteve mentioned this pull request Sep 12, 2024
Merged
szabosteve added a commit to szabosteve/elasticsearch that referenced this pull request Sep 12, 2024
@szabosteve @leemthompo @Mikep86
[DOCS] Rework semantic search main page (elastic#112452)
0a84d10 
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Mike Pellegrini <[email protected]>
@szabosteve szabosteve mentioned this pull request Sep 12, 2024
Merged
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 8.x
✅ 8.15

elasticsearchmachine pushed a commit that referenced this pull request Sep 12, 2024
@szabosteve @leemthompo @Mikep86
[DOCS] Rework semantic search main page (#112452) (#112808)
5b2d861 
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Mike Pellegrini <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Sep 12, 2024
@szabosteve @leemthompo @Mikep86
[DOCS] Rework semantic search main page (#112452) (#112809)
16d49b9 
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Mike Pellegrini <[email protected]>
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

@leemthompo leemthompo leemthompo approved these changes

Assignees
No one assigned
Labels
>docs General docs changes Team:Docs Meta label for docs team v8.15.2 v8.16.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@szabosteve @elasticsearchmachine @Mikep86 @leemthompo @mark-vieira