Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Add usage guide #65

Merged
merged 2 commits into from
Mar 22, 2021
Merged

Conversation

VijayanB
Copy link
Member

Include usage guide to give detailed information about CLI features
and how to use CLI.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@VijayanB VijayanB added the Documentation Improvements or additions to documentation label Mar 19, 2021
@VijayanB VijayanB self-assigned this Mar 19, 2021
@codecov
Copy link

codecov bot commented Mar 19, 2021

Codecov Report

Merging #65 (66fa7d8) into main (a188a7c) will not change coverage.
The diff coverage is n/a.

❗ Current head 66fa7d8 differs from pull request most recent head b05c679. Consider uploading reports for the commit b05c679 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main      #65   +/-   ##
=======================================
  Coverage   64.29%   64.29%           
=======================================
  Files          30       30           
  Lines        1546     1546           
=======================================
  Hits          994      994           
  Misses        448      448           
  Partials      104      104           
Flag Coverage Δ
odfe-cli 64.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@VijayanB VijayanB force-pushed the docs-usage branch 2 times, most recently from 83c745b to ae0bd76 Compare March 19, 2021 04:46
@@ -0,0 +1,185 @@
# Using the ODFE CLI
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, we should just refer to ODFE CLI by its name: odfe-cli

@VijayanB VijayanB requested a review from aetter March 19, 2021 19:04
@VijayanB
Copy link
Member Author

@aetter can you review this? Thanks

Include usage guide to give detailed information about CLI features
and how to use CLI.
Copy link

@aetter aetter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not aware of the curl stuff. That's awesome. Will test.

Copy link
Member

@vamshin vamshin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@VijayanB VijayanB merged commit 821c79c into opendistro-for-elasticsearch:main Mar 22, 2021
@VijayanB VijayanB deleted the docs-usage branch March 22, 2021 20:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants