Commit Graph

18 Commits

Author SHA1 Message Date
kolchfa-aws 1c94816cf6
Update the Update and Bulk API's update/upsert sections (#6182)
* Update the Update API and upsert operation

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>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2024-01-17 08:51:10 -05:00
kolchfa-aws 87b7045e66
Rename cat indexes to cat indices (#5802)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-12-06 08:10:52 -05:00
Samuel Valdes Gutierrez 7012af124a
[OSCI][DOCs] Replacing 'indices' terms for 'indexes' terms ONLY for description texts (#5353)
* Fixing documentation for Wildcard in term-level queries section for Query DSL

Signed-off-by: Samuel Valdes Gutierrez <valdesgutierrez@gmail.com>

* replacing 'indices' term for 'indexes' term ONLY for description texts (not variables, links or properties)

Signed-off-by: Samuel Valdes Gutierrez <valdesgutierrez@gmail.com>

* Update creating-custom-workloads.md

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

* updating changes suggested by Naarcha-AWS

Signed-off-by: Samuel Valdes Gutierrez <valdesgutierrez@gmail.com>

* updating changes suggested by Naarcha-AWS

Signed-off-by: Samuel Valdes Gutierrez <valdesgutierrez@gmail.com>

* Rename _benchmark/workloads/index.md to _benchmark/workloads/reference/index.md

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

* Rename _benchmark/workloads/indices.md to _benchmark/workloads/reference/indices.md

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

---------

Signed-off-by: Samuel Valdes Gutierrez <valdesgutierrez@gmail.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-10-31 10:18:45 -05:00
Samuel Valdes Gutierrez f51f7a6524
Update cat-repositories.md (#5296)
Signed-off-by: Samuel Valdes Gutierrez <valdesgutierrez@gmail.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-10-26 14:15:56 -05:00
MUHAMMAD SAMIULLAH 84e4ab158e
[DOC] Format all API pages according to the API template (#5169)
* Fix APIs File

Signed-off-by: samipak458 <samipak458@gmail.com>

* Update API files according to API template

Signed-off-by: samipak458 <samipak458@gmail.com>

* Update exec-stored-script.md

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

* Update cat-aliases.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-allocation.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-cluster_manager.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-count.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-field-data.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-health.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* updated

* updated

* updated

---------

Signed-off-by: samipak458 <samipak458@gmail.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-10-23 09:53:52 -05:00
Tianli Feng 4d6106a6ce
Add `bytes` into "Query parameters" for CAT Segment Replication API (#4731)
* Add `byte` into "Query parameters" for CAT Segment Replication API

Signed-off-by: Tianli Feng <ftianli@amazon.com>

* Add a trailing slash to the links

Signed-off-by: Tianli Feng <ftianli@amazon.com>

* Correct the parameter name to bytes

Signed-off-by: Tianli Feng <ftianli@amazon.com>

* Change data type of 'bytes' and 'time' parameters to 'Byte unites' and 'Time unites'

Signed-off-by: Tianli Feng <ftianli@amazon.com>

---------

Signed-off-by: Tianli Feng <ftianli@amazon.com>
2023-08-10 10:20:24 -04:00
Heather Halter 837112f9b6
Fixes to redirects (#4195)
* redirects

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixedformat

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixbrokenlink

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixbrokenlink

Signed-off-by: Heather Halter <hdhalter@amazon.com>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-26 14:48:31 -07:00
Heather Halter 6f6848dff8
More redirect updates (#4077)
* more redirects

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixlinks

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* fixedlinks

Signed-off-by: Heather Halter <hdhalter@amazon.com>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-15 14:59:57 -07:00
Heather Halter 22cfcf119b
CAT API redirects (#3965)
* catapi redirects

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* data prepper redirects

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* committing unsaved

Signed-off-by: Heather Halter <hdhalter@amazon.com>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-04 11:22:52 -07: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
kolchfa-aws 9913d1d640
Add CAT segment replication API (#2937)
* Add CAT segment replication API

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

* Refactoring after a conversation with SMEs

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

* Added copy buttons and changed sample to example

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

* Revise for 2.7

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

* Added aliases

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

* Reorder pages

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

* Update cat-segment-replication.md

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>

* Implemented doc review comments

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

* Update cat-segment-replication.md

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>

* Implemented editorial review comment

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

* Fix link

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

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-02 11:05:49 -04:00
kolchfa-aws 7992ec0196
Adds copy buttons to API and field type sections (#2518)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-01-30 17:09:38 -05:00
Aria Marble 2f814facb3
Correct API endpoints for CAT API reference (#2158)
Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-12-13 09:52:53 -08:00
Aria Marble 3266212dad
Fix table formatting on CAT allocation page (#2151)
* Fix table formatting on CAT allocation page

Signed-off-by: ariamarble <armarble@amazon.com>

* made suggested changes

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-12-07 16:21:03 -08:00
Aria Marble aaad91a4ed
CAT API inclusive language update (#2136)
Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-12-06 13:52:33 -08:00
Alice Williams fe8d702ca9
add operation to titles to differentiate from the API group acronym (#1750)
* add operation to titles to differentiate from the API group acronym

Signed-off-by: alicejw <alicejw@amazon.com>

* update frontmatter with new page title

Signed-off-by: alicejw <alicejw@amazon.com>

* for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713

Signed-off-by: alicejw <alicejw@amazon.com>

* to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly

Signed-off-by: alicejw <alicejw@amazon.com>

* to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-10-31 09:21:32 -07:00
Alice Williams 3d3f28ae14
update frontmatter for parent name title to Compact and aligned text (CAT) API (#1740)
Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-10-27 12:43:03 -05:00
Naarcha-AWS 7bb41fe4ce
Make API reference top level (#1637)
* Make API reference top level

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

* Fix typo on Drag and Drop page (#1633)

* Fix typo on Drag and Drop page

* Update _dashboards/drag-drop-wizard.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update drag-drop-wizard.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Putting all the Docker install material on a single page (#1452)

* Putting all the Docker install material on a single page

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Making room for revamp

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Intro added

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing to flesh out the intro section and overview

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Overview finalized

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Introducing docker compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added link to compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing docker image commentary

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Sometimes I wonder if anyone reads these

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding notes on installing compose with pip

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding prereqs

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Magnets - how do they work?

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Almonds and peaches are part of the same plant subgenus, Amygdalus

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* There are 293 ways to make change for a dollar

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* A shark is the only known fish that can blink with both eyes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* A crocodile cannot stick its tongue out

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* wording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Reorganizing a couple paragraphs to make it flow better

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Forgot a word

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Add tip about pruning stopped containers

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Cleaning up

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Add blurb about container ls

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding the Docker Compose stuff

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working on compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing work on the compose section - it's a lot of info

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added important settings

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Updates to settings that need configured

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Still working through compose things

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed wording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working through compose commands and guidance

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Reordering/rewording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More phrasing

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More wording in steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More wording in steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Organizing

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding stuff and things

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing to work through the configuration steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Still working on the configuration steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More work

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed perf analyzer - refer to GH issue 1555

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixing things

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding guidance on passing settings in compose

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working through dockerfile materials now

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* wording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finalized the sample dev compose file

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing work with configuration

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finished - ready for reviews

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed a link I forgot to change before

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changes from first proofread

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changed heading

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Addressed reviewer comments and made some changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Forgot to incorporate one change. Fixed.

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final editorial changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* fix#1584-custom_attr_allowlist (#1636)

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

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

* Update TERMS.md with definition for Setting (#1632)

* fix#1631-Terms-setting

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

* fix#1631-Terms-setting

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

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

* Add disclaimer about remote fs usage and an example of setting env var (#1644)

* Add disclaimer about remote fs usage and an example of setting env var

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Enhanced wording a little bit

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* [DOC] New documentation: Self-host maps server (#1625)

* Add new page self-host maps server

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

* Added new content

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

* Copy edit

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

* Tech review edits

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

* Doc review edits

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

* Editorial review changes

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

* Final edits

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

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

* Add feedback.

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

* Fix links

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: vagimeli <vagimeli@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Jeff Huss <jeffhuss@amazon.com>
Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
2022-10-27 11:50:39 -05:00