[Backport 2.x] [Doc] Correct "help" command to reflect actual behavio…

…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>
opensearch-project · Nov 29, 2022 · 3b41ec4 · 3b41ec4
1 parent 7fe28ab
commit 3b41ec4
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -57,6 +57,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### 📝 Documentation
 
 * [MD] Add design documents of multiple data source feature [#2538](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2538)
+* Corrected README and help command of osd-plugin-helpers ([#2810](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2810))
 ### 🛠 Maintenance
 
 ### 🪛 Refactoring

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 }) {