Adding the Hamilton/UI README

DAGWorks-Inc · May 1, 2024 · ff26243 · ff26243
1 parent cd688ed
commit ff26243
Show file tree

Hide file tree

Showing 21 changed files with 25 additions and 11 deletions.
diff --git a/ui/README.md b/ui/README.md
@@ -1,23 +1,37 @@
 # Hamilton UI
 
-This contains the code for the new Hamilton UI. Read the documentation for getting started
-[here](https://hamilton.dagworks.io/en/latest/concepts/ui/).
+This contains the code for the new Hamilton UI. For an overview of getting started & featuresr
+[see this documentation](https://hamilton.dagworks.io/en/latest/concepts/ui). For a lengthier post and intro see our [blog post](https://blog.dagworks.io/p/hamilton-ui-streamlining-metadata).
 
-## Overview
+## One operational UI for all your dataflows
 
-The Hamilton UI is an application that does the following:
+The Hamilton UI is a system that does the following:
 
-1. Tracks Hamilton executions through an SDK using the [lifecycle adapter framework](https://hamilton.dagworks.io/en/latest/reference/lifecycle-hooks/)
-2. Provides telemetry/monitoring of Hamilton executions + specific function results/code through a web interface
-3. Provides a persistent database to store/manage these
-4. Provides a server that allows reading/writing/authentication
+1. Tracks Hamilton Executions & surrounding metadata through an SDK using the [lifecycle adapter framework](https://hamilton.dagworks.io/en/latest/reference/lifecycle-hooks/)
+   * Provides a persistent database to store/manage these
+   * Provides a server that allows reading/writing/authentication
+2. Observability: provides telemetry/observability of Hamilton executions + specific function results/code through a web interface
+3. Lineage & Provenance: allows you to quickly inspect how code and data is connected.
+4. Catalog: everything is observed and cataloged, so you can quickly search and find what exists and when it was run.
 
-It is meant to be used both for debugging purposes and for monitoring Hamilton executions in production.
+The UI is meant to be used both for debugging purposes and for monitoring Hamilton executions in production.
 It works with the vast majority of Hamilton features.
 
-## Docs/usage
 
-See documentation [here](https://hamilton.dagworks.io/en/latest/concepts/ui).
+## Getting started
+Make sure you have docker running:
+```bash
+# clone the repository if you haven't
+git clone https://github.com/dagworks-inc/hamilton
+# change into the UI directory
+cd hamilton/ui
+# run docker
+./deployment/run.sh
+```
+Once docker is running navigate to http://localhost:8242 and create an email and a project; then follow
+instructions on integrating with Hamilton.
+
+A fuller guide can be found [here](https://hamilton.dagworks.io/en/latest/concepts/ui).
 
 ## Architecture
 

diff --git a/ui/screenshots/artifact_execution_metadata.png b/ui/screenshots/artifact_execution_metadata.png
diff --git a/ui/screenshots/catalog_artifact.png b/ui/screenshots/catalog_artifact.png
diff --git a/ui/screenshots/catalog_transform.png b/ui/screenshots/catalog_transform.png
diff --git a/ui/screenshots/code_view_graph.png b/ui/screenshots/code_view_graph.png
diff --git a/ui/screenshots/code_view_normal.png b/ui/screenshots/code_view_normal.png
diff --git a/ui/screenshots/execution_code_comparison.png b/ui/screenshots/execution_code_comparison.png
diff --git a/ui/screenshots/execution_code_view.png b/ui/screenshots/execution_code_view.png
diff --git a/ui/screenshots/execution_comparison_waterfall.png b/ui/screenshots/execution_comparison_waterfall.png
diff --git a/ui/screenshots/execution_data_comparison.png b/ui/screenshots/execution_data_comparison.png
diff --git a/ui/screenshots/execution_data_view.png b/ui/screenshots/execution_data_view.png
diff --git a/ui/screenshots/execution_graph_error.png b/ui/screenshots/execution_graph_error.png
diff --git a/ui/screenshots/execution_stacktrace.png b/ui/screenshots/execution_stacktrace.png
diff --git a/ui/screenshots/execution_summary_page.png b/ui/screenshots/execution_summary_page.png
diff --git a/ui/screenshots/execution_waterfall_view.png b/ui/screenshots/execution_waterfall_view.png
diff --git a/ui/screenshots/lineage_code_view.png b/ui/screenshots/lineage_code_view.png
diff --git a/ui/screenshots/lineage_code_view_grouped_by_module.png b/ui/screenshots/lineage_code_view_grouped_by_module.png
diff --git a/ui/screenshots/lineage_group_by_module.png b/ui/screenshots/lineage_group_by_module.png
diff --git a/ui/screenshots/lineage_side_panel.png b/ui/screenshots/lineage_side_panel.png
diff --git a/ui/screenshots/lineage_view.png b/ui/screenshots/lineage_view.png
diff --git a/ui/screenshots/version_view.png b/ui/screenshots/version_view.png