Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] Correct "help" command to reflect actual behaviour #2810

Merged
merged 3 commits into from
Nov 22, 2022
Merged

[Doc] Correct "help" command to reflect actual behaviour #2810

merged 3 commits into from
Nov 22, 2022

Conversation

Patrick-Clausen
Copy link
Contributor

@Patrick-Clausen Patrick-Clausen commented Nov 5, 2022 •
edited
Loading

Signed-off-by: Patrick Clausen clausen.patrick@gmail.com

Description

Noticed that the README and "help" command for osd-plugin-helpers don't describe the correct flag for specifying OSD version. The plugin accepts -k, but the README and "help" command describe -v, which is the --verbose flag.

Issues Resolved

Decided not to open issue since its such a small change, but please say if this is needed anyway.

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
    • yarn test:ftr
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@Patrick-Clausen
[Doc] Correct "help" command to reflect actual behaviour
04c1855 
Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
@Patrick-Clausen Patrick-Clausen requested a review from a team as a code owner November 5, 2022 15:07
@Patrick-Clausen
Update CHANGELOG.md
66b170b 
Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
joshuarrrr
joshuarrrr previously approved these changes Nov 7, 2022
View reviewed changes
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

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

Thanks @Patrick-Clausen !

Flyingliuhub
Flyingliuhub previously approved these changes Nov 7, 2022
View reviewed changes
@Flyingliuhub
Copy link
Member

Thanks @Patrick-Clausen for quick fix.

ashwin-pc
ashwin-pc previously approved these changes Nov 7, 2022
View reviewed changes
@joshuarrrr joshuarrrr dismissed stale reviews from ashwin-pc, Flyingliuhub, and themself via b921f62 November 22, 2022 21:08
@ashwin-pc ashwin-pc merged commit 311fe91 into opensearch-project:main Nov 22, 2022
@joshuarrrr joshuarrrr added backport 1.x backport 2.x v1.3.7 v2.5.0 'Issues and PRs related to version v2.5.0' labels Nov 29, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 29, 2022
@github-actions
[Doc] Correct "help" command to reflect actual behaviour (#2810)
6767b98 
* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 311fe91)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 29, 2022
@github-actions
[Doc] Correct "help" command to reflect actual behaviour (#2810)
e96b48d 
* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 311fe91)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md
This was referenced Nov 29, 2022
Merged
Merged
joshuarrrr added a commit that referenced this pull request Nov 29, 2022
@opensearch-trigger-bot @github-actions @joshuarrrr
[Backport 2.x] [Doc] Correct "help" command to reflect actual behavio…
3b41ec4 
…ur (#2942)

* [Doc] Correct "help" command to reflect actual behaviour (#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 311fe91)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Add changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
joshuarrrr added a commit that referenced this pull request Nov 30, 2022
@opensearch-trigger-bot @github-actions @joshuarrrr
[Backport 1.x] [Doc] Correct "help" command to reflect actual behavio…
9b7023f 
…ur (#2943)

* [Doc] Correct "help" command to reflect actual behaviour (#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 311fe91)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Update changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 30, 2022
@github-actions @joshuarrrr
[Backport 1.x] [Doc] Correct "help" command to reflect actual behavio…
7ae8a39 
…ur (#2943)

* [Doc] Correct "help" command to reflect actual behaviour (#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 311fe91)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Update changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 9b7023f)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuarrrr added a commit to joshuarrrr/OpenSearch-Dashboards that referenced this pull request Nov 30, 2022
@github-actions @joshuarrrr
[Backport 1.x] [Doc] Correct "help" command to reflect actual behavio…
b3c9ff5 
…ur (opensearch-project#2943)

* [Doc] Correct "help" command to reflect actual behaviour (opensearch-project#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 311fe91)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Update changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 9b7023f)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshuarrrr added a commit that referenced this pull request Dec 1, 2022
@joshuarrrr @github-actions
[Backport 1.3] [Doc] Correct "help" command to reflect actual behavio…
63cd78b 
…ur (#2975)

* [Backport 1.x] [Doc] Correct "help" command to reflect actual behaviour (#2943)

* [Doc] Correct "help" command to reflect actual behaviour (#2810)

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 311fe91)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

# Conflicts:
#	CHANGELOG.md

* [Chore] Update changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 9b7023f)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* [Chore] Update changelog

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AlexRuiz7 pushed a commit to wazuh/wazuh-dashboard that referenced this pull request Dec 14, 2022
@Patrick-Clausen @joshuarrrr @AlexRuiz7
[Doc] Correct "help" command to reflect actual behaviour (opensearch-…
c59f472 
…project#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
AlexRuiz7 pushed a commit to wazuh/wazuh-dashboard that referenced this pull request Dec 14, 2022
@Patrick-Clausen @joshuarrrr @AlexRuiz7
[Doc] Correct "help" command to reflect actual behaviour (opensearch-…
1307fbb 
…project#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
sipopo pushed a commit to sipopo/OpenSearch-Dashboards that referenced this pull request Dec 16, 2022
@Patrick-Clausen @joshuarrrr @sipopo
[Doc] Correct "help" command to reflect actual behaviour (opensearch-…
8373c92 
…project#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: Sergey Osipov <sipopo@yandex.ru>
Arpit-Bandejiya pushed a commit to Arpit-Bandejiya/OpenSearch-Dashboards that referenced this pull request Jan 13, 2023
@Patrick-Clausen @joshuarrrr @Arpit-Bandejiya
[Doc] Correct "help" command to reflect actual behaviour (opensearch-…
c0bf6cf 
…project#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: Arpit Bandejiya <abandeji@amazon.com>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
@Patrick-Clausen @joshuarrrr @sikhote
[Doc] Correct "help" command to reflect actual behaviour (opensearch-…
7f4c20b 
…project#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: David Sinclair <david@sinclair.tech>
sikhote pushed a commit to sikhote/OpenSearch-Dashboards that referenced this pull request Apr 24, 2023
@Patrick-Clausen @joshuarrrr @sikhote
[Doc] Correct "help" command to reflect actual behaviour (opensearch-…
f3b59f8 
…project#2810)

* [Doc] Correct "help" command to reflect actual behaviour

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

* Update CHANGELOG.md

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>

Signed-off-by: Patrick Clausen <clausen.patrick@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
Signed-off-by: David Sinclair <david@sinclair.tech>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshuarrrr joshuarrrr joshuarrrr approved these changes

@ashwin-pc ashwin-pc ashwin-pc approved these changes

@Flyingliuhub Flyingliuhub Awaiting requested review from Flyingliuhub Flyingliuhub is a code owner

Assignees
No one assigned
Labels
backport 2.x v1.3.7 v2.5.0 'Issues and PRs related to version v2.5.0'
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Patrick-Clausen @Flyingliuhub @joshuarrrr @ashwin-pc