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

Dedupe and clarify "Search your data" #213

Merged
merged 5 commits into from
Nov 25, 2024

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Nov 21, 2024

Issue: https://github.com/elastic/search-docs-team/issues/226
Companion PR: #205

These docs now avoid duplicating content from core ES documentation to reduce maintenance overhead and prevent documentation drift. Instead, they focus on serverless-specific content and refer to core docs for implementation details.

These docs were manually duplicated a looong time ago and are now incomplete and out of date.

👀 URL preview

Summary of changes

search-your-data.asciidoc

  • Rewritten for serverless context
  • Links to quickstart tutorials and notebooks
  • Points to core docs for concepts

search-your-data-the-search-api.asciidoc

  • Added Retrievers section
  • Simplified Query DSL explanation
  • References core ES docs

knn-search.asciidoc

  • Removed duplicated implementation guides
  • References core ES docs
  • Added tip for "bring your own vectors" tutorial

search-with-synonyms.asciidoc

  • deleted, redirect already in place

> Important: These docs now avoid duplicating content from core ES documentation to reduce maintenance overhead and prevent documentation drift. Instead, they focus on serverless-specific content and refer to core docs for implementation details.

These docs were manually duplicated a looong time ago and are now incomplete and out of date.

- Removed duplicated implementation guides
- References core ES docs
- Added tip for "bring your own vectors" tutorial

- Removed duplicated implementation details
- Points to core ES docs
- Marked as duplicate/removed from navigation

- Added Retrievers section
- Simplified Query DSL explanation
- References core ES docs

- Rewritten for serverless context
- Links to quickstart tutorials and notebooks
- Points to core docs for concepts
@leemthompo leemthompo requested a review from a team as a code owner November 21, 2024 13:44
@leemthompo leemthompo self-assigned this Nov 21, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

overall, not sure why the child pages stayed when the core message of the parent is "it works exactly the same as regular elasticsearch" - keeping the child pages sends a signal that these features work differently in serverless.

wonder if a better strategy would be "here are some key features we want to highlight" on that top level page, with links out.

* What processes on my server take longer than 500 milliseconds to respond?
* What users on my network ran regsvr32.exe within the last week?
* What pages on my website contain a specific word or phrase?
You can also run searches using *Discover* in your project's UI.
Copy link
Collaborator

Choose a reason for hiding this comment

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

can you link to discover docs here?

@@ -1,26 +1,23 @@
[[elasticsearch-search-your-data]]
= Search your data
Copy link
Collaborator

Choose a reason for hiding this comment

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

these pages with children should always introduce their child pages

Copy link
Collaborator

Choose a reason for hiding this comment

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

unclear why you chose to keep this page

Copy link
Collaborator

Choose a reason for hiding this comment

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

same with this one

@leemthompo
Copy link
Contributor Author

wonder if a better strategy would be "here are some key features we want to highlight" on that top level page, with links out.

long story short it would have taken more time to merge all this content and make it legible, rather than just an undifferentiated list of stuff, so for the moment there's a little pre-curation here before being sent into the jungles of the ES guide

was rushing with this and the important thing is removing the out-of-date duplication, so can revisit in follow-up and set up redirects etc.

these pages with children should always introduce their child pages

👍

shainaraskas
shainaraskas previously approved these changes Nov 25, 2024
Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

came back with some little nitpicks. nudge me when you want the final ✅

serverless/pages/search-your-data-the-search-api.asciidoc Outdated Show resolved Hide resolved
serverless/pages/search-your-data.asciidoc Outdated Show resolved Hide resolved
serverless/pages/search-your-data.asciidoc Outdated Show resolved Hide resolved
@leemthompo
Copy link
Contributor Author

Thanks feel free to merge

@shainaraskas shainaraskas merged commit 51e950e into elastic:main Nov 25, 2024
2 checks passed
@leemthompo leemthompo deleted the revamp-search-your-data branch November 26, 2024 08:46
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.

2 participants