Auto Generate Architect Documentation

.github/workflows/deploy-docs.yml

@@ -21,7 +21,9 @@ jobs:
           node-version: 16.x
           cache: yarn
       - name: Auto Generate Blueprint Docs
-        run: python mephisto/scripts/local_db/gh_actions/auto_generate_blueprint.py
+        run: |
+          python mephisto/scripts/local_db/gh_actions/auto_generate_blueprint.py
+          python mephisto/scripts/local_db/gh_actions/auto_generate_architect.py
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Build website

docs/web/docs/reference/Architects.md

@@ -0,0 +1,56 @@
+
+
+
+
+# Architects
+
+## mock
+
+
+
+
+|dest|type|default|help|choices|required|
+| :--- | :--- | :--- | :--- | :--- | :--- |
+|server_type|str|node|None|None|False|
+|server_source_path|str|???|Optional path to a prepared server directory containing everything needed to run a server of the given type. Overrides server type. |None|False|
+|should_run_server|bool|False|Addressible location of the server|None|False|
+|port|str|3000|Port to launch the server on|None|False|
+
+## local
+
+
+
+
+|dest|type|default|help|choices|required|
+| :--- | :--- | :--- | :--- | :--- | :--- |
+|server_type|str|node|None|None|False|
+|server_source_path|str|???|Optional path to a prepared server directory containing everything needed to run a server of the given type. Overrides server type. |None|False|
+|hostname|str|localhost|Addressible location of the server|None|False|
+|port|str|3000|Port to launch the server on|None|False|
+
+## heroku
+
+
+
+
+|dest|type|default|help|choices|required|
+| :--- | :--- | :--- | :--- | :--- | :--- |
+|server_type|str|node|None|None|False|
+|server_source_path|str|???|Optional path to a prepared server directory containing everything needed to run a server of the given type. Overrides server type. |None|False|
+|use_hobby|bool|False|Launch on the Heroku Hobby tier|None|False|
+|heroku_team|unknown|???|Heroku team to use for this launch|None|False|
+|heroku_app_name|unknown|???|Heroku app name to use for this launch|None|False|
+|heroku_config_args|unknown|{}|str:str dict containing all heroku config variables to set for the app|None|False|
+
+## ec2
+
+
+
+
+|dest|type|default|help|choices|required|
+| :--- | :--- | :--- | :--- | :--- | :--- |
+|server_type|str|node|None|None|False|
+|server_source_path|str|???|Optional path to a prepared server directory containing everything needed to run a server of the given type. Overrides server type. |None|False|
+|instance_type|str|t2.micro|Instance type to run router|None|False|
+|subdomain|str|The task name defined in your task's hydra config|Subdomain name for routing|None|False|
+|profile_name|str|???|Profile name for deploying an ec2 instance|None|False|

docs/web/docs/reference/blueprints.md

@@ -4,6 +4,8 @@
 
 # Blueprints
 
+
+The blueprint determines the task content.
 ## parlai chat
 
 

mephisto/client/cli_commands.py

@@ -134,7 +134,11 @@ def get_wut_arguments(args):
             return
 
     # These are values that do not convert to a string well or are incorrect, so they need to be hardcoded
-    argument_overrides = {"tips_location": ("default", "path_to_task/assets/tips.csv")}
+    argument_overrides = {
+        "tips_location": ("default", "path_to_task/assets/tips.csv"),
+        "heroku_config_args": ("default", "{}"),
+        "subdomain": ("default", "The task name defined in your task's hydra config"),
+    }
 
     arg_dict = get_extra_argument_dicts(target_class)[0]
     click.echo(arg_dict["desc"])

mephisto/scripts/local_db/gh_actions/auto_generate_architect.py

@@ -0,0 +1,27 @@
+from mdutils.mdutils import MdUtils
+from mephisto.client.cli_commands import get_wut_arguments
+from mephisto.operations.registry import get_valid_architect_types
+from mephisto.scripts.local_db.gh_actions.auto_generate_blueprint import (
+    create_blueprint_info,
+)
+
+
+def main():
+    architect_file = MdUtils(
+        file_name="../../../../docs/web/docs/reference/architects.md",
+    )
+    architect_file.new_header(level=1, title="Architects")
+    valid_architect_types = get_valid_architect_types()
+    for architect_type in valid_architect_types:
+        architect_file.new_header(level=2, title=architect_type.replace("_", " "))
+        args = get_wut_arguments(
+            ("architect={architect_name}".format(architect_name=architect_type),)
+        )
+        arg_dict = args[0]
+        create_blueprint_info(architect_file, arg_dict)
+
+    architect_file.create_md_file()
+
+
+if __name__ == "__main__":
+    main()

mephisto/scripts/local_db/gh_actions/auto_generate_blueprint.py

@@ -1,7 +1,6 @@
 from mephisto.client.cli_commands import get_wut_arguments
 from mdutils.mdutils import MdUtils
 from copy import deepcopy
-
 from mephisto.operations.registry import get_valid_blueprint_types
 
 
@@ -49,6 +48,7 @@ def main():
         file_name="../../../../docs/web/docs/reference/blueprints.md",
     )
     blueprint_file.new_header(level=1, title="Blueprints")
+    blueprint_file.new_paragraph("The blueprint determines the task content.")
     valid_blueprint_types = get_valid_blueprint_types()
     for blueprint_type in valid_blueprint_types:
         blueprint_file.new_header(level=2, title=blueprint_type.replace("_", " "))