Commit Graph

10 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
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
Aria Marble 82b2416df3
Add documentation for nodes api (#1560)
* adding documentation for nodes api

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

* made suggested changes

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

* minor format change

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

* quick terminology changes

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-14 08:25:33 -07:00
kolchfa-aws 85b18f7c58
Adds nodes stats API (#1369)
* Adds nodes stats API

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

* Refactored hot threads and info APIs

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

* Incorporated doc review comments

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

* Incorporated review feedback

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

* Formatting changes

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update _opensearch/rest-api/nodes-apis/index.md

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

* Update nodes-hot-threads.md

* Update nodes-hot-threads.md

* Update nodes-hot-threads.md

* Update nodes-info.md

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update nodes-info.md

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

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

* Update nodes-stats.md

* Incorporated nodes stats editorial comments

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
2022-10-08 18:02:27 -04:00
Lukáš Vlček 98c7dd29a6 Fixing Nodes APIs issues
1. Fixing all reported dead links.
2. Changing `title` value in index.md back to plural form, i.e. "Nodes APIs".

The second change fixed missing child pages. I am not saying I insist on use of plural form but if we want to change it to a singular form then we also have to change `parent` fields in all child pages to correctly refer to valid parent, otherwise all child pages and content is missing.

As for the debate of use APIs vs API (plural vs singular) I just want to point out that right now there are many other parent pages using plural form. If we want to change that then I suggest doing it in separate PR and include other relevant parent pages too.

Closes: #591
Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
2022-05-20 11:36:23 +02:00
Naarcha-AWS 6ad4d00060 Add editorial review
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-19 10:23:12 -05:00
Naarcha-AWS 03807527eb More feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 13:00:47 -05:00
Naarcha-AWS 6b2042745e Add feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 12:54:11 -05:00
Naarcha-AWS bde449d48a Writer review
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 10:34:34 -05:00
Lukáš Vlček 2df0f8450b Introduce Nodes APIs
In this commit we are introducing a new section in REST API Reference for Nodes APIs.

We are adding documentation for "Nodes hot threads" and "Nodes info". Because Nodes APIs share common request parameters we also add more detailed section into parent index page (notice that the nodes-filter parameter was moved from "Cluster stats" page and was improved, and relevant links were updated).

There are more Nodes APIs that still need to be documented, this is just a good start.

We updated nav_order parameter for some pages as well.

Relevant ticket: #424

Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
2022-04-22 18:40:11 +02:00