Merge pull request #21 from Eventual-Inc/docs/iam-instance-profile-arn

[Docs] Update docs

.github/workflows/deploy-mdbook.yaml

@@ -33,11 +33,11 @@ jobs:
         id: pages
         uses: actions/configure-pages@v5
       - name: Build with mdBook
-        run: mdbook build docs/book
+        run: mdbook build docs
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: ./docs/book/book
+          path: ./docs/book
 
   deploy-book:
     environment:

daft_launcher/cli.py

@@ -8,6 +8,12 @@
 DEFAULT_CONFIG_PATH = Path(".daft.toml")
 
 
+def generate_intro_message():
+    summary = metadata.metadata("daft-launcher").get("Summary")
+    info_string = "For more documentation, please visit:\n\nhttps://eventual-inc.github.io/daft-launcher"
+    return f"{summary}\n\n{info_string}"
+
+
 def get_config_path(config: Optional[Path]) -> Path:
     if config:
         if not config.exists():
@@ -40,9 +46,9 @@ def get_new_configuration_file_path(name: Optional[Path]) -> Path:
     if name.is_file():
         raise click.UsageError(f"A configuration file at path {name} already exists.")
     elif name.is_dir():
-        raise click.UsageError(f"That is the path to a directory; please pass in a file name.")
+        raise click.UsageError("That is the path to a directory; please pass in a file name.")
     elif name.exists():
-        raise click.UsageError(f"That path already exists; please use a new one.")
+        raise click.UsageError("That path already exists; please use a new one.")
 
     return name
 
@@ -193,7 +199,7 @@ def down(config: Optional[Path]):
     commands.down(config)
 
 
-@click.group(help=metadata.metadata("daft-launcher").get("Summary"))
+@click.group(help=generate_intro_message())
 @click.version_option(version=metadata.version("daft-launcher"))
 def cli(): ...
 

docs/src/SUMMARY.md

@@ -0,0 +1,13 @@
+# Summary
+
+- [Introduction](./introduction.md)
+- [Commands](./commands/mod.md)
+  - [Init Config](./commands/init-config.md)
+  - [Up](./commands/up.md)
+  - [Down](./commands/down.md)
+  - [List](./commands/list.md)
+  - [Submit](./commands/submit.md)
+  - [Dashboard](./commands/dashboard.md)
+  - [Sql](./commands/sql.md)
+- [Example](./example.md)
+- [Future Plans](./future_plans.md)

docs/src/commands/dashboard.md

@@ -0,0 +1,18 @@
+## Dashboard
+
+The dashboard command enables you to view the Ray dashboard of a specified cluster that you currently have running.
+The way this is done is by establishing a port-forward over SSH from your local machine to the head node of the cluster (connecting `localhost:8265` to the remote head's `8265`).
+The head node then serves some HTML/CSS/JS that you can view in your browser by pointing it towards `localhost:8265`).
+
+An important thing to note is that this command will require that you have the appropriate private SSH keypair to authenticate against the remote head's public SSH keypair.
+You will need to pass this SSH keypair as an argument to the command.
+
+### Example
+
+```bash
+# establish the port-forward using the default .daft.toml configuration file
+daft dashboard -i my-keypair.pem
+
+# or, if you want, establish the port-forward using a custom configuration file
+daft dashboard -c my-custom-config.toml -i my-keypair.pem
+```

docs/src/commands/down.md

@@ -0,0 +1,17 @@
+## Down
+
+The down command is pretty much the opposite of the up command.
+It takes the cluster specified in the configuration file and tears it down.
+
+### Example
+
+```bash
+# spin down a cluster using the default .daft.toml configuration file
+daft down
+
+# or, if you want, spin down a cluster using a custom configuration file
+daft down -c my-custom-config.toml
+```
+
+This command will tear down *all* instances in the cluster, not just the head node.
+When each instance has been requested to shut down, the command will return successfully.