From f271fdfb2bbdb9f16f3cb3c656dc05bace68f8d8 Mon Sep 17 00:00:00 2001
From: Jordan Keister <jordan@nimblewidget.com>
Date: Tue, 9 Aug 2022 14:58:43 -0500
Subject: [PATCH 1/4] examples for  to generate channel graph images

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
---
 cmd/opm/render/cmd.go | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/cmd/opm/render/cmd.go b/cmd/opm/render/cmd.go
index 448097a73..5b65d6749 100644
--- a/cmd/opm/render/cmd.go
+++ b/cmd/opm/render/cmd.go
@@ -26,6 +26,31 @@ func NewCmd() *cobra.Command {
 		Long: `Generate a declarative config blob from the provided index images, bundle images, and sqlite database files
 
 ` + sqlite.DeprecationMessage,
+		Example: `
+#
+# Output declarative configuration view of an index-image in JSON format
+#
+$ opm render quay.io/operatorhubio/catalog:latest
+
+#
+# Output declarative configuration view of a bundle-image in YAML format
+#
+$ opm render quay.io/operatorhubio/ack-apigatewayv2-controller@sha256:14c507f2ecb4a64928bcfcf5897f4495d9988f4d7ff58f41e029359a9fe78c38
+
+#
+# Output channel graph of a catalog in mermaid format
+#
+$ opm render quay.io/operatorhubio/catalog:latest -o mermaid
+
+#
+# Output channel graph of a catalog and generate a scaled vector graphic (SVG) representation
+# Note:  this pipeline filters out the comments about lacking skipRange support
+#
+$ opm render quay.io/operatorhubio/catalog:latest -o mermaid | \
+    grep -Ev '^<!--.*$' | \
+    docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -o /data/operatorhubio-catalog.svg
+
+		`,
 		Args: cobra.MinimumNArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
 			render.Refs = args

From 9a64a7fb36e224a7ec199e2241f1ae0e6354c03f Mon Sep 17 00:00:00 2001
From: Jordan Keister <jordan@nimblewidget.com>
Date: Fri, 19 Aug 2022 15:21:15 -0500
Subject: [PATCH 2/4] added details for how to avoid mermaid's maxTextSize
 limits

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
---
 cmd/opm/render/cmd.go | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/cmd/opm/render/cmd.go b/cmd/opm/render/cmd.go
index 5b65d6749..ffed33c24 100644
--- a/cmd/opm/render/cmd.go
+++ b/cmd/opm/render/cmd.go
@@ -50,6 +50,17 @@ $ opm render quay.io/operatorhubio/catalog:latest -o mermaid | \
     grep -Ev '^<!--.*$' | \
     docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -o /data/operatorhubio-catalog.svg
 
+# Note:  mermaid has a default maxTextSize of 30 000 characters.  To override this, generate a JSON-formatted initialization file for
+# mermaid like this (using 300 000 for the limit):
+$ cat << EOF > ./mermaid.json
+{ "maxTextSize": 300000 }
+EOF
+# and then pass the file for initialization configuration, via the '-c' option, like:
+$ opm render quay.io/operatorhubio/catalog:latest -o mermaid | \
+    grep -Ev '^<!--.*$' | \
+    docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -c /data/mermaid.json -o /data/operatorhubio-catalog.svg
+
+
 		`,
 		Args: cobra.MinimumNArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {

From 33e901a50ee9b998e943477e1137597682966787 Mon Sep 17 00:00:00 2001
From: Jordan Keister <jordan@nimblewidget.com>
Date: Wed, 24 Aug 2022 07:51:06 -0500
Subject: [PATCH 3/4] fixing comment

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
---
 cmd/opm/render/cmd.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/cmd/opm/render/cmd.go b/cmd/opm/render/cmd.go
index ffed33c24..28930932d 100644
--- a/cmd/opm/render/cmd.go
+++ b/cmd/opm/render/cmd.go
@@ -35,7 +35,7 @@ $ opm render quay.io/operatorhubio/catalog:latest
 #
 # Output declarative configuration view of a bundle-image in YAML format
 #
-$ opm render quay.io/operatorhubio/ack-apigatewayv2-controller@sha256:14c507f2ecb4a64928bcfcf5897f4495d9988f4d7ff58f41e029359a9fe78c38
+$ opm render quay.io/operatorhubio/ack-apigatewayv2-controller@sha256:14c507f2ecb4a64928bcfcf5897f4495d9988f4d7ff58f41e029359a9fe78c38 -o yaml
 
 #
 # Output channel graph of a catalog in mermaid format

From f9023d90ae5b5604c06cc0c00a1c85f731186288 Mon Sep 17 00:00:00 2001
From: Jordan Keister <jordan@nimblewidget.com>
Date: Mon, 29 Aug 2022 11:18:22 -0500
Subject: [PATCH 4/4] revised for the new render-graph command

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
---
 cmd/opm/alpha/render-graph/cmd.go | 26 ++++++++++++++++++++++
 cmd/opm/render/cmd.go             | 36 -------------------------------
 2 files changed, 26 insertions(+), 36 deletions(-)

diff --git a/cmd/opm/alpha/render-graph/cmd.go b/cmd/opm/alpha/render-graph/cmd.go
index 72a7666c8..de8109923 100644
--- a/cmd/opm/alpha/render-graph/cmd.go
+++ b/cmd/opm/alpha/render-graph/cmd.go
@@ -22,6 +22,32 @@ func NewCmd() *cobra.Command {
 		Short: "Generate mermaid-formatted view of upgrade graph of operators in an index",
 		Long:  `Generate mermaid-formatted view of upgrade graphs of operators in an index`,
 		Args:  cobra.MinimumNArgs(1),
+		Example: `
+#
+# Output channel graph of a catalog in mermaid format
+#
+$ opm alpha render-graph quay.io/operatorhubio/catalog:latest
+
+#
+# Output channel graph of a catalog and generate a scaled vector graphic (SVG) representation
+# Note:  this pipeline filters out the comments about lacking skipRange support
+#
+$ opm alpha render-graph quay.io/operatorhubio/catalog:latest | \
+    grep -Ev '^<!--.*$' | \
+    docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -o /data/operatorhubio-catalog.svg
+
+# Note:  mermaid has a default maxTextSize of 30 000 characters.  To override this, generate a JSON-formatted initialization file for
+# mermaid like this (using 300 000 for the limit):
+$ cat << EOF > ./mermaid.json
+{ "maxTextSize": 300000 }
+EOF
+# and then pass the file for initialization configuration, via the '-c' option, like:
+$ opm alpha render-graph quay.io/operatorhubio/catalog:latest | \
+    grep -Ev '^<!--.*$' | \
+    docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -c /data/mermaid.json -o /data/operatorhubio-catalog.svg
+
+
+		`,
 		Run: func(cmd *cobra.Command, args []string) {
 			// The bundle loading impl is somewhat verbose, even on the happy path,
 			// so discard all logrus default logger logs. Any important failures will be
diff --git a/cmd/opm/render/cmd.go b/cmd/opm/render/cmd.go
index 28930932d..448097a73 100644
--- a/cmd/opm/render/cmd.go
+++ b/cmd/opm/render/cmd.go
@@ -26,42 +26,6 @@ func NewCmd() *cobra.Command {
 		Long: `Generate a declarative config blob from the provided index images, bundle images, and sqlite database files
 
 ` + sqlite.DeprecationMessage,
-		Example: `
-#
-# Output declarative configuration view of an index-image in JSON format
-#
-$ opm render quay.io/operatorhubio/catalog:latest
-
-#
-# Output declarative configuration view of a bundle-image in YAML format
-#
-$ opm render quay.io/operatorhubio/ack-apigatewayv2-controller@sha256:14c507f2ecb4a64928bcfcf5897f4495d9988f4d7ff58f41e029359a9fe78c38 -o yaml
-
-#
-# Output channel graph of a catalog in mermaid format
-#
-$ opm render quay.io/operatorhubio/catalog:latest -o mermaid
-
-#
-# Output channel graph of a catalog and generate a scaled vector graphic (SVG) representation
-# Note:  this pipeline filters out the comments about lacking skipRange support
-#
-$ opm render quay.io/operatorhubio/catalog:latest -o mermaid | \
-    grep -Ev '^<!--.*$' | \
-    docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -o /data/operatorhubio-catalog.svg
-
-# Note:  mermaid has a default maxTextSize of 30 000 characters.  To override this, generate a JSON-formatted initialization file for
-# mermaid like this (using 300 000 for the limit):
-$ cat << EOF > ./mermaid.json
-{ "maxTextSize": 300000 }
-EOF
-# and then pass the file for initialization configuration, via the '-c' option, like:
-$ opm render quay.io/operatorhubio/catalog:latest -o mermaid | \
-    grep -Ev '^<!--.*$' | \
-    docker run --rm -i -v "$PWD":/data ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -c /data/mermaid.json -o /data/operatorhubio-catalog.svg
-
-
-		`,
 		Args: cobra.MinimumNArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
 			render.Refs = args