feat: doc fixes (#234)

Author: rameziophobia

README.md

@@ -1,9 +1,9 @@
 # The power of Kubernetes with the ease of Heroku!
 
-<meta name="author" content="Justin Gordon and Sergey Tarasov">
-<meta name="description" content="Instructions on how to migrate from Heroku to Control Plane and a CLI called cpflow to make it easier.">
-<meta name="copyright" content="ShakaCode, 2023">
-<meta name="keywords" content="Control Plane, Heroku, Kubernetes, K8, Infrastructure">
+<meta name="author" content="Justin Gordon and Sergey Tarasov" />
+<meta name="description" content="Instructions on how to migrate from Heroku to Control Plane and a CLI called cpflow to make it easier." />
+<meta name="copyright" content="ShakaCode, 2023" />
+<meta name="keywords" content="Control Plane, Heroku, Kubernetes, K8, Infrastructure" />
 <meta name="google-site-verification" content="dIV4nMplcYl6YOKOaZMqgvdKXhLJ4cdYY6pS6e_YrPU" />
 
 [![RSpec](https://github.com/shakacode/control-plane-flow/actions/workflows/rspec.yml/badge.svg)](https://github.com/shakacode/control-plane-flow/actions/workflows/rspec.yml)

docs/commands.md

@@ -1,4 +1,4 @@
-<!-- NOTE: This file is automatically generated by running `script/generate_commands_docs`. Do NOT edit it manually. -->
+{ /* Automatically Generated <!-- NOTE: This file is automatically generated by running `script/update_command_docs`. Do NOT edit it manually. --> */}
 
 ## Common Options
 
@@ -431,8 +431,8 @@ cpflow run -a $APP_NAME --entrypoint /app/alternative-entrypoint.sh -- rails db:
 - Creates an app and all its workloads
 - Specify the templates for the app and workloads through `setup_app_templates` in the `.controlplane/controlplane.yml` file
 - This should only be used for temporary apps like review apps, never for persistent apps like production or staging (to update workloads for those, use 'cpflow apply-template' instead)
-- Configures app to have org-level secrets with default name "{APP_PREFIX}-secrets"
-  using org-level policy with default name "{APP_PREFIX}-secrets-policy" (names can be customized, see docs)
+- Configures app to have org-level secrets with default name `"{APP_PREFIX}-secrets"`
+  using org-level policy with default name `"{APP_PREFIX}-secrets-policy"` (names can be customized, see docs)
 - Creates identity for secrets if it does not exist
 - Use `--skip-secrets-setup` to prevent the automatic setup of secrets,
   or set it through `skip_secrets_setup` in the `.controlplane/controlplane.yml` file

lib/command/setup_app.rb

@@ -14,8 +14,8 @@ class SetupApp < Base
       - Creates an app and all its workloads
       - Specify the templates for the app and workloads through `setup_app_templates` in the `.controlplane/controlplane.yml` file
       - This should only be used for temporary apps like review apps, never for persistent apps like production or staging (to update workloads for those, use 'cpflow apply-template' instead)
-      - Configures app to have org-level secrets with default name "{APP_PREFIX}-secrets"
-        using org-level policy with default name "{APP_PREFIX}-secrets-policy" (names can be customized, see docs)
+      - Configures app to have org-level secrets with default name `"{APP_PREFIX}-secrets"`
+        using org-level policy with default name `"{APP_PREFIX}-secrets-policy"` (names can be customized, see docs)
       - Creates identity for secrets if it does not exist
       - Use `--skip-secrets-setup` to prevent the automatic setup of secrets,
         or set it through `skip_secrets_setup` in the `.controlplane/controlplane.yml` file

script/update_command_docs

@@ -44,7 +44,7 @@ commands_str = commands_str_arr.join("\n\n")
 file_path = "#{__dir__}/../docs/commands.md"
 file_data =
   <<~DATA
-    <!-- NOTE: This file is automatically generated by running `script/generate_commands_docs`. Do NOT edit it manually. -->
+    { /* Automatically Generated <!-- NOTE: This file is automatically generated by running `script/update_command_docs`. Do NOT edit it manually. --> */}
 
     ## Common Options