[Doc] Correct "help" command to reflect actual behaviour (opensearch-…

…project#2810) * [Doc] Correct "help" command to reflect actual behaviour Signed-off-by: Patrick Clausen <[email protected]> * Update CHANGELOG.md Signed-off-by: Patrick Clausen <[email protected]> Signed-off-by: Patrick Clausen <[email protected]> Co-authored-by: Josh Romero <[email protected]>
joshuarrrr · Nov 22, 2022 · 311fe91 · 311fe91
1 parent 575863c
commit 311fe91
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -80,6 +80,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Add the release runbook to RELEASING.md ([#2533](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2533))
 - [MD] Add design documents of multiple data source feature [#2538](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2538)
 - [MD] Tweak multiple data source design doc [#2724](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2724)
+- Corrected README and help command of osd-plugin-helpers ([#2810](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2810))
 - Add `current-usage.md` and more details to `README.md` of `charts` plugin ([#2695](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2695))
 
 ### 🛠 Maintenance

diff --git a/packages/osd-plugin-helpers/README.md b/packages/osd-plugin-helpers/README.md
@@ -49,7 +49,7 @@ $ plugin-helpers help
 
       Options:
         --skip-archive                       Don't create the zip file, just create the build/opensearch-dashboards directory
-        --opensearch-dashboards-version, -v  OpenSearch Dashboards version that the built plugin will target
+        --opensearch-dashboards-version, -k  OpenSearch Dashboards version that the built plugin will target
     
      
     version

diff --git a/packages/osd-plugin-helpers/src/cli.ts b/packages/osd-plugin-helpers/src/cli.ts
@@ -66,7 +66,7 @@ export function runCli() {
         },
         help: `
           --skip-archive                       Don't create the zip file, just create the build/opensearch-dashboards directory
-          --opensearch-dashboards-version, -v  OpenSearch version that the
+          --opensearch-dashboards-version, -k  OpenSearch Dashboards version that the built plugin will target
         `,
       },
       async run({ log, flags }) {