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

[Request]: Consider removing or updating the reindex method on the Observability AI Assistant doc #4352

Open
eedugon opened this issue Oct 7, 2024 · 1 comment

Comments

@eedugon
Copy link
Contributor

eedugon commented Oct 7, 2024

Description

The procedure described on the section === Use the {es} Reindex API of the document has the following issues:

  1. It's too advanced.
  2. The destination index proposed might not be valid if data is rolled over.
  3. The first step about indexing data with the Index API is now useless considering they can do that with Search Connectors and also integrate the data directly with the AI Assistant knowledge base.

Resources

Background:

Now that we have added in #4326 the information about how Search Connectors can help to enrich the AI Assistant Knowledge base, the method of using Reindex API proposed in the doc on the section...

=== Use the {es} Reindex API

... is probably not needed (or at least not needed as it is).

I would suggest to:

  • Determine the need of sharing such an advanced procedure to reindex data directly towards a system index (.kibana-observability-ai-assistant-kb-000001) now that there are other ways to enrich the AI Assistant KB.
  • Consider moving this type of procedure to an Elastic KB article instead of keeping it in the public document.

If we want to keep the content, then the following updates should be needed (IMO):

  • Add an introduction about when that procedure might be useful (for example to include existing data in Elasticsearch to the AI Assistant knowledge base)
  • Update the destination index of the reindex operation to use an alias and not a hardcoded index that could be rolled over.
  • Explain or add a note about this being an advanced procedure.
  • Consider a troubleshooting section (that's also another reason to move this to a Knowledge Article instead of keeping in the main doc.

cc: @lucabelluccini , if possible I'd love to hear your opinion on this.
cc: @emma-raffenne , as this is a follow up of our previous work, could you check this with @dgieselaar or someone else from the team?

Which documentation set does this change impact?

Stateful and Serverless

Feature differences

Both docs are very similar so in case of moving forward with this we should update both documents.

What release is this request related to?

8.16

Collaboration model

The documentation team

Point of contact.

Main contact: @eedugon

Stakeholders: @emma-raffenne

@emma-raffenne
Copy link

@eedugon
Thank you for creating this issue.
As @dgieselaar mentioned elsewhere, we don't want to recommend this method for adding content to the Knowledge Base, so IMO it's safe to remove it entirely from the user documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants