Commit Graph

139 Commits

Author SHA1 Message Date
kolchfa-aws 63019c421d
Puts column headers in sentence case (#1989)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-18 15:25:06 -05:00
Alice Williams fce925640a
For [Doc] Alerting plugin RBAC - backend roles usage (#1866)
* for doc issue https://github.com/opensearch-project/documentation-website/issues/1810

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

* to add reference link to security plugin section about backend roles

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

* more updates and fix link

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

* for link to backend roles in Alerting API doc

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

* to fine tune the backend_role creation of role1, and role2

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

* for tech review feedback updates

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

* minor update to remove xref to the monitoring page limit access to backend roles section

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

* put notes into a callout

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

* for more updates per tech review

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

* for doc review feedback updates

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-11-15 09:41:07 -08:00
Alice Williams f94d0710b5
update image for Dashboards Alerting plugin (#1791)
* new image of Dashboards

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

* update link to new image

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

* fix figure title

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-11-04 18:10:17 -07: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
kolchfa-aws 8c4735156c
Fixes script display errors (#1692)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-10-26 11:44:18 -04:00
Aria Marble 15c76088fe
Performance analyzer documentation updates (#1318)
* updated incorrect links

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

* performance analyzer documentation update

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

* draft update

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

* converting to ready for review

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

* tech review updates

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

* made suggested changes

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

* made further changes and fixed header

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

* editorial changes

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

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-12 09:22:07 -07:00
Alice Williams 282a26ebfe
[Bug] Fix broken cross-ref links in the docs (#1253)
* to fix broken cross-ref links

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

* replace removed link

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-16 17:07:38 -07:00
Jeff Huss c9912dd5f6
Moved the info over to the pa page (#1134)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-09-07 13:31:54 -07:00
Alice Williams df51655e4b
custom json model for anomaly detector (#1091)
* custom json model for anomaly detector #910

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

* for additional steps

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

* for UI element reformat to bold per style guide

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

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-06 13:48:06 -07:00
Jeff Huss 3ac63b596c
Relocated perf analyzer installation steps to the appropriate page (#963)
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-08-23 15:11:13 -07:00
Naarcha-AWS e2d593d544
Add feature attribution documentation (#871)
* Add feature attribution documentation

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

* Delete references to removed images

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

* Add technical feedback

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

* Add new images. Delete redundant note

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

* Fix a formatting bug

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

* Add editorial feedback

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

* Add more editorial feedback

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-08-11 17:48:32 -05:00
kolchfa-aws f225c77c34
Snapshot management (#757)
* Added snapshot management

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

* Snapshot management v2

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

* Added snapshot management

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

* Added user roles

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

* Added SME comments

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

* Changed dashboards access from index management to snapshot management

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

* Editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-07-07 14:19:01 -04:00
Jeff Huss 9aa614c4b5
Fixed broken links in cat*.md, api.md and monitoring.md (#726)
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
2022-06-27 15:09:21 -07:00
Alice Williams 95a614ebb5
Merge branch 'main' into 475-doc-level-alerts 2022-05-26 13:58:32 -07:00
alicejw 80e816914d for merge conflict resolution
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 13:53:32 -07:00
alicejw 0489b7fb7d move tag syntax table to api proc section
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 13:47:59 -07:00
alicejw a1ea42892b for note to refer to api section
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 13:42:20 -07:00
alicejw 4fcbb1dc6b for additional review updates
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 13:32:45 -07:00
alicejw 26fafde644 for API renaming throughout
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 13:13:25 -07:00
alicejw 1d22b88e34 remove findings resource mention
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 11:08:56 -07:00
alicejw 4756b8a40e for tech review updates
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 11:04:23 -07:00
alicejw efe631d4e2 typo
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 16:39:13 -07:00
alicejw 6f35e155ad clarity/concise intro
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 14:25:04 -07:00
alicejw 6778dc6013 final update
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 14:22:26 -07:00
alicejw a2b0e8ecd6 for per doc monitor API description
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 14:09:19 -07:00
alicejw f9107ad07b for rewrites
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 14:02:23 -07:00
alicejw a83d2408ec key terms to top of page
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 13:00:37 -07:00
alicejw 8dc16205fa clarify search monitor API example
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 12:58:08 -07:00
alicejw 68bcb49213 additional updates for Alerting API
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 12:36:38 -07:00
alicejw d69f01e73d for additional information about findings index and search API
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-25 11:14:12 -07:00
keithhc2 3a39c484e7 Even more comments
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-05-25 08:55:00 -07:00
Keith Chan d7f42451e4
Merge branch 'main' into notifications 2022-05-24 09:32:21 -07:00
alicejw b7aa7d91e5 updates per editorial review
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-24 09:22:18 -07:00
keithhc2 105ad2448f Typo
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-05-24 09:10:29 -07:00
keithhc2 32bf7947a8 Addressed comments
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-05-23 23:46:35 -07:00
alicejw 740330f9fe rename to exact name for monitor type: document-level monitor
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 17:35:30 -07:00
alicejw c754ff36b7 add per document monitor instead of document-level
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 17:26:35 -07:00
alicejw 3785b0f3e0 for API version of per doc monitor instructions
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 17:22:32 -07:00
alicejw 0e6171fb9d for 2nd tech review updates
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 16:48:07 -07:00
alicejw 3710812533 for tech review updates
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 16:43:57 -07:00
alicejw 95d03c0aa5 clarify how to create combo queries with a tag
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 16:04:24 -07:00
alicejw 7f866181d4 fix Alerting plugin uppercase entries
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 15:52:35 -07:00
alicejw 09fcd521f5 finish overview
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 15:08:35 -07:00
alicejw 65da8844c2 for combined trigger condition with tag instructions
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 14:57:58 -07:00
alicejw dcf2cca6a4 for 1st draft final writer checklist - now ready for tech review
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 14:47:42 -07:00
alicejw 814b3af150 separate section about per document multiple triggers with tags applied
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 14:27:11 -07:00
alicejw 36271a32b6 how to add doc-level triggers and tags
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 14:18:27 -07:00
alicejw 3aa1fe2973 for initial draft of per doc monitors
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-23 10:42:17 -07:00
keithhc2 a3f2b7ff2d Changed behavior in ISM and Alerting, and added more details
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-05-18 11:37:47 -07:00
Naarcha-AWS 35bfcd883d
Merge pull request #512 from opensearch-project/remove-mapping-types2.0
Remove type from all API requests and responses
2022-05-03 14:33:31 -05:00