* Add script documentation.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Use my own example script insteady of Elastic's.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* edditing and format changes. verified API requests and scripts. various corrections
Signed-off-by: ariamarble <armarble@amazon.com>
* made a couple of suggested changes
Signed-off-by: ariamarble <armarble@amazon.com>
* made further corrections
Signed-off-by: ariamarble <armarble@amazon.com>
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Added guidance about zip syntax differences between local and remote files
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added disclaimer about Maven
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added disclaimer about protocols
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Caught a small typo and fixed it
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added Maven coordinates syntax and sample command
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Changes to the overall layout
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Removed the extra table of contents - users don't need 3 on the same page
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Minor changes
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Finished clean up
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Found a missing word and fixed it
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* New PR because the old one was corrupted by a commit without DCO
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Fixed syntax for bullet/numbered lists.
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added validation steps to the end
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Cleaning up phrasing and grammar
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Making some changes based on peer feedback
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Fixing opening section
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Fixing phrasing and rewording headers
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Cleaning up more
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Moved unrelated content to the appropriate pages and deleted from this guide
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added templates for links
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added a few related links that make sense as logical next steps
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Cleaned up link formatting. Ready for review now.
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Applied changes recommended by vagimeli
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Applied changed from PR review
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added step numbers to headers and periods to bullet list at the top
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Fix typo in script comment
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Made most of the editorial changes but there are a couple open items
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Final editorial changes applied, ready to merge
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
There is no mention of doc_as_upsert in OS documention, but it appears to be supported. Some examples to go along with the passing mention of scripts & especially upsert would go a long way
This also addresses #755
Signed-off-by: Alek Poteet <patrick.poteet@shipveho.com>
Signed-off-by: Alek Poteet <patrick.poteet@shipveho.com>
* Added list of plugins that can be installed by name
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Fixed a typo
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added plugin-name to the command under additional plugins
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* add files for snapshot creation
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Create new topics and fix existing. Modify index.md
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Address Fanit's edits. Apply edits to other files as needed for consistenty. Create new files: get-snapshot.status.md and restore-snapshot.md.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Add .md file extension to get-snapshot-repository file
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Add verify-snapshot-repository.md, renumber nav_order in other snapshot topics to place the new topic correctly.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Apply Fanit's edits to restore-snapsnot.md and verify-snapshot-repository.md
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Address Fanit's edits.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Change 'Response fields' heading level to 3.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Co-authored-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Removed html table and added markdown table
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Removed html table and added markdown table part 2
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Sorted list of plugins
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Added repo links and plugin names
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* A little more polish. Ready for review.
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* Small tweaks to formatting so the footnote doesn't run into the end of the table
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
* added resource_stats object to sample responses
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Added information about log files
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Removed resource_stats from existing sample responses that lack the detailed flag
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Added example with detailed parameter
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Changed phrasing to use active voice
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Removed extra comma from sample JSON and rephrased feature description
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Replaced query string in detailed flag example with placeholder
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Small wording change
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Add ML node instructions
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Change cluster settings from ml to dynamic
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Quick typo fix
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Adjust ML docs to remove dymanic mention. Adjust CAT example to be general
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Add editorial feedback.
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Fix columns in example
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Make sure 2.x yum installation match 1.x naming patterns
Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
* Tweak a bit
Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
* Tweak a bit
Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
* for cluster manager term update
Signed-off-by: alicejw <alicejw@amazon.com>
* for small fix
Signed-off-by: alicejw <alicejw@amazon.com>
* to change to
Signed-off-by: alicejw <alicejw@amazon.com>
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>
Additional improvements:
- The master_timeout is marked as deprecated and cluster_manager_timeout is suggested instead
- A required permissions is also documented
- The JSON example response is completed
Closes: #552
Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
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>
Jeff Huss
Aria Marble
Chris Moore
Alek Poteet
Melissa Vagi
STEVE MURPHY
Naarcha-AWS
kolchfa-aws
Anil Jaiswal
Peter Zhu
Sayali Gaikawad
Alice Williams
Liz Snyder
Fanit Kolchina
alicejw
Naarcha-AWS
dblock
Lukáš Vlček
Carlos Neto
sruti1312