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

[DOCS] Consolidates ELSER deployment guide with ES deployment tutorial content #2560

Merged
merged 4 commits into from
Oct 12, 2023

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Oct 11, 2023

Overview

Related to https://github.com/elastic/platform-docs-team/issues/237 and https://github.com/elastic/enterprise-search-team/issues/5901.

This PR adds the majority of the ELSER-related deployment content from the Enterprise Search book to the ELSER conceptual docs, it also adds a new section to the page called Performance considerations that copies the relevant information to the page from the Limitations and notes section of the ES page.

Preview

ELSER ES

@github-actions
Copy link

Documentation preview:

@mergify mergify bot added the backport-skip Skip automated backport with mergify label Oct 11, 2023
@szabosteve szabosteve added :ml WIP Work in progress nlp ELSER v8.11 backport-8.11 Automated backport with mergify v8.12 and removed backport-skip Skip automated backport with mergify labels Oct 11, 2023
@elastic elastic deleted a comment from mergify bot Oct 11, 2023
Copy link
Contributor

@chriscressman chriscressman left a comment

Choose a reason for hiding this comment

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

@szabosteve These changes look great.

I suggested a few changes inline. There are also two instances where the Kibana breadcrumb needs to be updated. The breadcrumb used to be "Enterprise Search > Indices", but now it is "Search > Indices". I forgot to call this out in the requirements.

I didn't spot any other instances of "Enterprise Search" in the doc, but in general we want to get rid of any mentions of Enterprise Search and instead present this as a feature specific to Elasticsearch and Kibana.

docs/en/stack/ml/nlp/ml-nlp-elser.asciidoc Outdated Show resolved Hide resolved
docs/en/stack/ml/nlp/ml-nlp-elser.asciidoc Outdated Show resolved Hide resolved
docs/en/stack/ml/nlp/ml-nlp-elser.asciidoc Show resolved Hide resolved
@szabosteve
Copy link
Contributor Author

@chriscressman Thank you for your thoughtful review; I updated the breadcrumbs and addressed your comments via f02d5ee.

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.

Nice, thanks for driving this one!

@szabosteve szabosteve merged commit 1957a2b into elastic:main Oct 12, 2023
1 check passed
@szabosteve szabosteve deleted the elser-es-deploy branch October 12, 2023 11:15
mergify bot pushed a commit that referenced this pull request Oct 12, 2023
szabosteve added a commit that referenced this pull request Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.11 Automated backport with mergify ELSER :ml nlp v8.11 v8.12 WIP Work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants