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

Update README.md #222

Merged

Conversation

VijayanB
Copy link
Member

@VijayanB VijayanB commented Sep 3, 2020

Add installation steps from binaries

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

Add installation steps from binaries
@VijayanB VijayanB self-assigned this Sep 3, 2020
@VijayanB VijayanB added the documentation Improvements or additions to documentation label Sep 3, 2020
@codecov
Copy link

codecov bot commented Sep 3, 2020

Codecov Report

Merging #222 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #222      +/-   ##
============================================
+ Coverage     72.41%   72.43%   +0.01%     
- Complexity     1290     1291       +1     
============================================
  Files           139      139              
  Lines          6073     6073              
  Branches        469      469              
============================================
+ Hits           4398     4399       +1     
  Misses         1464     1464              
+ Partials        211      210       -1     
Flag Coverage Δ Complexity Δ
#cli 80.30% <ø> (ø) 0.00 <ø> (ø)
#plugin 71.38% <ø> (+0.01%) 1291.00 <ø> (+1.00)

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

Impacted Files Coverage Δ Complexity Δ
...asticsearch/ad/cluster/ADClusterEventListener.java 94.00% <0.00%> (+2.00%) 15.00% <0.00%> (+1.00%)

Use version flag to check version
cli/README.md Outdated
sudo mv ./esad /usr/local/bin/esad

```
4. Test to ensure the version you installed is up-to-date:
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we show the version is update to date or not with command esad --version ? Or we just show version info, user need to figure out by themselves?

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated the step now. Can you review it again?

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good, thanks

```
3. Move the binary in to your PATH.
```
sudo mv ./esad /usr/local/bin/esad
Copy link
Contributor

Choose a reason for hiding this comment

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

This requires user have enough permission to move esad to local bin folder. How about add another option for user who has no sudo permission? Will be a blocker for some user if AD CLI must need sudo permission.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ack

Add instruction for non-sudo users.
@VijayanB VijayanB merged commit d886520 into opendistro-for-elasticsearch:master Sep 4, 2020
@VijayanB VijayanB deleted the update-read-me branch September 4, 2020 20:28
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.

3 participants