-
Notifications
You must be signed in to change notification settings - Fork 25.6k
Improve documentation for Linear Top Level Normalizer #134216
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
Improve documentation for Linear Top Level Normalizer #134216
Conversation
|
Pinging @elastic/search-relevance (Team:Search - Relevance) |
|
Pinging @elastic/core-docs (Team:Docs) |
🔍 Preview links for changed docs |
ℹ️ Important: Docs version tagging👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version. We use applies_to tags to mark version-specific features and changes. Expand for a quick overviewWhen to use applies_to tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory) What NOT to do:❌ Don't remove or replace information that applies to an older version 🤔 Need help?
|
docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md
Outdated
Show resolved
Hide resolved
|
@leemthompo @dimitris-athanasiou can you please approve the finalised version or please let me know if any further changes are required? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a final tweak. I recommend always checking the URL preview to make sure that docs changes make sense for the reader, especially when using these inline applies_to tags which need to clearly target a specific section :)
docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md
Outdated
Show resolved
Hide resolved
docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md
Outdated
Show resolved
Hide resolved
…ever.md Co-authored-by: Liam Thompson <[email protected]>
…ever.md Co-authored-by: Liam Thompson <[email protected]>
* Improved changes to the doc * Add back missing warning about avoiding 'none' normalizer with field grouping * Move applies_to tag to specific behavior description to clarify version support * cleaning it up * cleaned up * cleaned up * Update linear-retriever.md * Update docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md Co-authored-by: Liam Thompson <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]>
* Improved changes to the doc * Add back missing warning about avoiding 'none' normalizer with field grouping * Move applies_to tag to specific behavior description to clarify version support * cleaning it up * cleaned up * cleaned up * Update linear-retriever.md * Update docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md Co-authored-by: Liam Thompson <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]>
This PR adds a clarification in the linear top level normalizer.
Follow up from PR: #129693