Commit Graph

11 Commits

Author SHA1 Message Date
Lukáš Vlček 29f42850fe
Add documentation for Normalizers (#6415)
Improve the documentation for Analyzers (some terminology was
not correct) also fix some broken links along the way.

Note: this commit is a spin-off of #6252

Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
2024-02-15 10:04:47 -05:00
Chenyang Ji c87bd64a57
Add Query Insights documentation (#6261)
* Query Insights initial documentation

Signed-off-by: Chenyang Ji <cyji@amazon.com>

* Doc review

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* update endpoints and remove exporters

Signed-off-by: Chenyang Ji <cyji@amazon.com>

* Moved query insights to additional plugins section

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added installation instructions

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Resolve merge conflicts

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* merge conflicts and link fix

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix link

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Chenyang Ji <cyji@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-13 14:35:03 -05:00
10000-ki f482849094
Add installing multiple plugins example (#6358)
* Add installing multiple plugins example

Add installing multiple plugins example

Signed-off-by: 10000-ki <10000ki6472@gmail.com>

fix text

Signed-off-by: 10000-ki <10000ki6472@gmail.com>

* Update plugins.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

---------

Signed-off-by: 10000-ki <10000ki6472@gmail.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
2024-02-09 12:19:28 -07:00
kolchfa-aws 6c92b54eba
Add flow framework documentation (#6257)
* Add flow framework documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _automating-workflows/api/create-workflow.md

Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Add callout of edges being optional

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add unregister to word list

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add registering local pretrained and custom models

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _automating-workflows/api/deprovision-workflow.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _automating-workflows/workflow-steps.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Added Flow Framework plugin to Vale

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* More editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _automating-workflows/api/get-workflow-status.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _automating-workflows/api/get-workflow-status.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Add note about provisioning

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _automating-workflows/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _automating-workflows/workflow-steps.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* More editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Removed code font from headings

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add agent documentation links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add experimental label and more links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add sample templates link

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added a tracking issue to warning

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-02-07 18:44:49 -05:00
Andrew Ross a7df8220dd
Add custom-codecs to list of bundled plugins (#5000)
Signed-off-by: Andrew Ross <andrross@amazon.com>
2023-09-22 17:30:44 -04:00
Sarthak Aggarwal de4276a00d
Adds ZSTD and ZSTD_NO_DICT codecs to core (out of sandbox) (#4421)
* documentation for zstd and zstd out of sandbox

Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update create-index.md

Added a new section with codec information

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update create-index.md

Fixed the code samples

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update create-index.md

Added back a heading 'Index Settings' since it caused broken links in other topics.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update create-index.md

Added the compression_level setting to the dynamic table.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update create-index.md

Added sentences about not being able to be updated dynamically.

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-19 11:12:48 -07:00
Peter Nied 8d1b2682f4
Add warning about plugin permission (#4383)
* Add warning about plugin permission

I didn't see any documentation that described what an installed plugin can do - and it would be good to make sure cluster operators have expectations described somewhere.

* Update plugins.md

* Update _install-and-configure/plugins.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Peter Nied <peternied@hotmail.com>

* Update _install-and-configure/plugins.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Peter Nied <peternied@hotmail.com>

* Incorperate cwillum's feedback

Signed-off-by: Peter Nied <peternied@hotmail.com>
Co-authored-by: cwillum <cwmmoore@amazon.com>

---------

Signed-off-by: Peter Nied <peternied@hotmail.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: cwillum <cwmmoore@amazon.com>
2023-07-05 13:12:54 -05:00
mulugetam 817b730908
Add documentation for the custom-codecs plugin. (#3913)
* Add documentation for the custom-codecs plugin.

  - Add documentation for the custom-codecs plugin (https://github.com/opensearch-project/OpenSearch/pull/3577).

Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _install-and-configure/plugins.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _install-and-configure/plugins.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-06-05 13:34:29 -05:00
kolchfa-aws 8463c8f278
Correct plugin capitalization (#3838)
* Correct plugin capitalization

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Revert cluster-stats because the name is in response

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Revert cluster-stats once more

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-04 11:11:54 -04:00
Chris Moore d04e88b496
Reorganize Configuration section of the Security TOC (#2212)
* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#2155-sec-toc-config-reorg

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Rename security section. Fix links. Add redirects

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Naarcha-AWS <naarcha@amazon.com>
2023-01-27 10:12:47 -08:00
Naarcha-AWS c2e423ff71
Remove Install and Configure home page (#2449)
* Remove install and configure home page

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add gerunds to plugin and configuration titles

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Make titles gerunds

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Small tweaks

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update plugins.md

* Remove index page

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-01-23 13:09:16 -06:00