From c0bf6cfc113e39ade105339d19a73237467dbb02 Mon Sep 17 00:00:00 2001 From: Patrick Clausen Date: Wed, 23 Nov 2022 00:58:26 +0100 Subject: [PATCH] [Doc] Correct "help" command to reflect actual behaviour (#2810) * [Doc] Correct "help" command to reflect actual behaviour Signed-off-by: Patrick Clausen * Update CHANGELOG.md Signed-off-by: Patrick Clausen Signed-off-by: Patrick Clausen Co-authored-by: Josh Romero Signed-off-by: Arpit Bandejiya --- CHANGELOG.md | 1 + packages/osd-plugin-helpers/README.md | 2 +- packages/osd-plugin-helpers/src/cli.ts | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 02511face519..37d21f377bdc 100644 --- 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 index 4a16bc9afe23..700999c26bf7 100644 --- 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 index f108f9a2f6ca..c4b1a83fedaf 100644 --- 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 }) {