add doc alias for generating docs (#47156)

deps.edn

@@ -318,6 +318,15 @@
                "-Dmacaw.run.mode=dev"
                "-Djava.awt.headless=true"]}                   ; prevent Java icon from randomly popping up in macOS dock
 
+  ;; run the prod server when generating docs
+  ;; as some default values differ between dev and prod
+  ;;
+  ;; clojure -M:ee:doc
+  :doc
+  {:main-opts ["-m" "metabase.bootstrap"]
+   :jvm-opts  ["-Dmb.run.mode=prod"
+               "-Djava.awt.headless=true"]}                   ; prevent Java icon from randomly popping up in macOS dock
+
   ;; alias for CI-specific options.
   :ci
   {:jvm-opts ["-Xmx12g"

docs/configuring-metabase/environment-variables.md

@@ -9,7 +9,7 @@ redirect_from:
 _This documentation was generated from source by running:_
 
 ```
-clojure -M:ee:run environment-variables-documentation
+clojure -M:ee:doc environment-variables-documentation
 ```
 
 Many settings in Metabase can be viewed and modified in the Admin Panel, or set via environment variables. The environment variables always take precedence. Note that, unlike settings configured in the Admin settings of your Metabase, the environment variables won't get written into the application database.
@@ -319,7 +319,7 @@ Timeout in milliseconds for connecting to databases, both Metabase application d
 ### `MB_DB_QUERY_TIMEOUT_MINUTES`
 
 - Type: integer
-- Default: `3`
+- Default: `20`
 
 By default, this is 20 minutes.
 

src/metabase/cmd/endpoint_dox.clj

@@ -260,7 +260,7 @@
                         "If you want to include them, run the command with"
                         \newline
                         \newline
-                        "clojure -M:ee:run api-documentation"))))
+                        "clojure -M:ee:doc api-documentation"))))
   (let [endpoint-map (map-endpoints)]
     (reset-dir (io/file "docs/api"))
     (generate-index-page! endpoint-map)

src/metabase/cmd/env_var_dox.clj

 (ns metabase.cmd.env-var-dox
   "Code to generate docs for environment variables. You can generate
-  docs by running: `clojure -M:ee:run environment-variables-documentation`"
+  docs by running: `clojure -M:ee:doc environment-variables-documentation`"
   (:require
    [clojure.java.classpath :as classpath]
    [clojure.java.io :as io]

src/metabase/cmd/resources/api-intro.md

@@ -7,7 +7,7 @@ title: "Metabase API documentation"
 _These reference files were generated from source comments by running:_
 
 ```
-clojure -M:ee:run api-documentation
+clojure -M:ee:doc api-documentation
 ```
 
 ## About the Metabase API

src/metabase/cmd/resources/env-var-intro.md

@@ -9,7 +9,7 @@ redirect_from:
 _This documentation was generated from source by running:_
 
 ```
-clojure -M:ee:run environment-variables-documentation
+clojure -M:ee:doc environment-variables-documentation
 ```
 
 Many settings in Metabase can be viewed and modified in the Admin Panel, or set via environment variables. The environment variables always take precedence. Note that, unlike settings configured in the Admin settings of your Metabase, the environment variables won't get written into the application database.