opensearch-project / index-management

🗃 Automate periodic data operations, such as deleting indices at a certain age or performing a rollover at a certain size
https://opensearch.org/docs/latest/im-plugin/index/
Apache License 2.0
52 stars 107 forks source link

[FEATURE] Improved Documentation for Index Transforms #1136

Open sarthakaggarwal97 opened 3 months ago

sarthakaggarwal97 commented 3 months ago

Is your feature request related to a problem? There is not enough documentation for transform job in OpenSearch. While it enumerates the purpose and the APIs of Index Transform, there is a scope of improvement over here.

Things to be covered in documentation

  1. Index Transforms as ISM Action
  2. Transform Index Settings
  3. Transform Phases
  4. Transform Metadata and Configurations

What solution would you like? We should consider adding elaborate documentation to enable and make the users aware of the capabilities of a transform job.

dblock commented 2 weeks ago

Catch All Triage - 1 2 3 4 5