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] - Elasticsearch - Split into user and administrator sections #4201

Open
QuiltSimon opened this issue Oct 22, 2024 · 5 comments · May be fixed by #4203
Open

[Docs] - Elasticsearch - Split into user and administrator sections #4201

QuiltSimon opened this issue Oct 22, 2024 · 5 comments · May be fixed by #4203
Assignees
Labels
documentation documentation suggestions and requests

Comments

@QuiltSimon
Copy link
Contributor

Currently the documentation page on Elasticsearch has sections relating to end user functionality (querying) and administrator functions (monitoring, auto-tuning and configuration).

Suggest we split this into two sections to better fit into each of the sections Quilt Platform User and Quilt Platform Administrator.

@QuiltSimon QuiltSimon added the documentation documentation suggestions and requests label Oct 22, 2024
@drernie
Copy link
Member

drernie commented Oct 22, 2024

While we are at it: we should probably pull out the Catalog-related entries from the (quilt3) FAQ

Similarly, the Catalog 'Advanced' could be merged into the main "Search & Query"

@drernie
Copy link
Member

drernie commented Oct 22, 2024

Possibly irrelevant, but the Admin API docs should be in Advanced (and need to be more readable).

@drernie
Copy link
Member

drernie commented Oct 22, 2024

Related: Rethinking Your Data Platform Documentation

Suggests four types:

  • Tutorial: I am new to the tool, and I want a hands-on onboarding
  • How-to: I know about the tool, but I wonder how to perform a specific task
  • Explanation: I want to learn about architecture choices, advanced concepts, etc.
  • Reference: I want to get an exhaustive list of all features/methods

@drernie
Copy link
Member

drernie commented Oct 24, 2024

NOTE: Warn people that re-indexing > 1M objects can get expensive.

Alternative:

  • Opensearch out of memory
  • Overview stats incorrect / not updating
    Check SNS topic and/or S3 event source (chain is S3 events => SNS => SQS => Lambda => ES
    ES is out of disk
    Workaround if dropped data while problem was occurring but is now fixed: re-index (not recommended for more than ~10M object buckets unless you're ready for a long re-index)

@drernie
Copy link
Member

drernie commented Oct 25, 2024

@QuiltSimon waiting for your review

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

Successfully merging a pull request may close this issue.

2 participants