feat(ui): Show first-time UX. Fixes #7160 (#7170)

Signed-off-by: Alex Collins <alex_collins@intuit.com>
argoproj · Jan 21, 2022 · c6be0fe · c6be0fe
1 parent 4e621b5
commit c6be0fe
Show file tree

Hide file tree

Showing 41 changed files with 631 additions and 56 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
@@ -5447,6 +5447,13 @@
         },
         "managedNamespace": {
           "type": "string"
+        },
+        "modals": {
+          "additionalProperties": {
+            "type": "boolean"
+          },
+          "title": "which modals to show",
+          "type": "object"
         }
       },
       "type": "object"

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -9710,6 +9710,13 @@
         },
         "managedNamespace": {
           "type": "string"
+        },
+        "modals": {
+          "type": "object",
+          "title": "which modals to show",
+          "additionalProperties": {
+            "type": "boolean"
+          }
         }
       }
     },

diff --git a/docs/client-libraries.md b/docs/client-libraries.md
@@ -21,7 +21,8 @@ The following client libraries are officially maintained by the Argo team.
 
 The following client libraries are provided and maintained by their authors, not the Argo team.
 
-| Language | Client Library | Info |
+| Language | Client Library | Examples/Docs |
 |----------|----------------|---------------|
 | Python | [Couler](https://github.com/couler-proj/couler) | Multi-workflow engine support Python SDK |
 | Python | [Hera](https://github.com/argoproj-labs/hera-workflows) | Easy and accessible Argo workflows construction and submission in Python |
+
diff --git a/docs/container-set-template.md b/docs/container-set-template.md
@@ -1,6 +1,6 @@
 # Container Set Template
 
-![alpha](assets/alpha.svg)
+![GA](assets/ga.svg)
 
 > v3.1 and after
 

diff --git a/docs/data-sourcing-and-transformation.md b/docs/data-sourcing-and-transformation.md
@@ -1,7 +1,5 @@
 # Data Sourcing and Transformations
 
-![alpha](assets/alpha.svg)
-
 > v3.1 and after
 
 #### Development

diff --git a/docs/environment-variables.md b/docs/environment-variables.md
@@ -142,3 +142,11 @@ data:
       - name: RESOURCE_STATE_CHECK_INTERVAL
         value: 3s
 ```
+
+## Argo Server
+
+| Name | Type | Default | Description |
+|------|------|---------|-------------|
+| `FIRST_TIME_USER_MODAL` | `bool` | `true` | Show this modal. |
+| `FEEDBACK_MODAL` | `bool` | `true` | Show this modal. |
+| `NEW_VERSION_MODAL` | `bool` | `true` | Show this modal. |
diff --git a/docs/estimated-duration.md b/docs/estimated-duration.md
@@ -1,7 +1,5 @@
 # Estimated Duration
 
-![alpha](assets/alpha.svg)
-
 > v2.12 and after
 
 When you run a workflow, the controller will try to estimate its duration.

diff --git a/docs/key-only-artifacts.md b/docs/key-only-artifacts.md
@@ -1,6 +1,5 @@
 # Key-Only Artifacts
 
-![Alpha](assets/alpha.svg)
 
 > v3.0 and after
 

diff --git a/docs/progress.md b/docs/progress.md
@@ -1,7 +1,5 @@
 # Workflow Progress
 
-![alpha](assets/alpha.svg)
-
 > v2.12 and after
 
 When you run a workflow, the controller will report on its progress.

diff --git a/docs/survey-data-privacy.md b/docs/survey-data-privacy.md
@@ -0,0 +1,3 @@
+# Survey
+
+TODO
diff --git a/docs/templates.md b/docs/templates.md
@@ -8,8 +8,6 @@ See [container set template](container-set-template.md).
 
 ## Inline Templates
 
-![alpha](assets/alpha.svg)
-
 > v3.2 and after
 
 You can inline other templates within DAG and steps.

diff --git a/docs/use-cases/ci-cd.md b/docs/use-cases/ci-cd.md
@@ -0,0 +1,14 @@
+# CI/CD
+
+## Docs
+
+* [Quick start](../quick-start.md) and [training](../training.md)
+* Learn about [webhooks](../webhooks.md) for triggering pipelines.
+* Head to the [Argo CD](https://github.com/argoproj/argo-cd/) docs.
+
+## Videos
+
+* [Distributed Load Testing Using Argo Workflows - Sumit Nagal (Intuit)](https://youtu.be/9zg2EH2pRw0?t=1200&utm_source=argo-docs)
+* [CI/CD for Machine Learning at MLB using Argo Workflows - Eric Meadows](https://youtu.be/fccWoYlwZKc?t=184&utm_source=argo-docs)
+* [How LitmusChaos uses Argo Workflows](https://youtu.be/QETfzfVV-GY?t=1954&utm_source=argo-docs)
+* [Tekton vs. Argo Workflows - Kubernetes-Native CI/CD Pipelines](https://www.youtube.com/watch?v=dAUpAq7hfeA?utm_source=argo-docs)
diff --git a/docs/use-cases/data-processing.md b/docs/use-cases/data-processing.md
@@ -0,0 +1,9 @@
+# Data Processing
+
+## Docs
+
+* [Quick start](../quick-start.md) and [training](../training.md)
+
+## Videos
+
+* [Running a Data Replication Pipeline on Kubernetes with Argo and Singer.io](https://towardsdatascience.com/running-a-data-replication-pipeline-on-kubernetes-with-argo-and-singer-io-2fab5b0bad?utm_source=argo-docs)
diff --git a/docs/use-cases/infrastructure-automation.md b/docs/use-cases/infrastructure-automation.md
@@ -0,0 +1,13 @@
+# Infrastructure Automation
+
+## Docs
+
+* [Quick start](../quick-start.md) and [training](../training.md)
+* Head to the [Argo Events](https://argoproj.github.io/argo-events/) docs.
+
+## Videos
+
+* [Infrastructure Automation with Argo at InsideBoard - Alexandre Le Mao  (Head of infrastructure / Lead DevOps, Insideboard)](https://www.youtube.com/watch?v=BochC4GKxbo&list=PLGHfqDpnXFXK4E8XzasScagiJk-8BPgva&index=2&utm_source=argo-docs)
+* [Argo and KNative - David Breitgand (IBM) - showing 5G infra automation use case](https://youtu.be/dxX_Xnp2sX4?t=210&utm_source=argo-docs)
+* [How New Relic Uses Argo Workflows - Fischer Jemison, Jared Welch (New Relic)](https://youtu.be/dxX_Xnp2sX4?t=1890&utm_source=argo-docs)
+* [Building Kubernetes using Kubernetes - Tomas Valasek (SAP Concur)](https://youtu.be/TLTxv2F5WCQ?t=1742&utm_source=argo-docs)
diff --git a/docs/use-cases/machine-learning.md b/docs/use-cases/machine-learning.md
@@ -0,0 +1,13 @@
+# Machine Learning
+
+## Docs
+
+* [Quick start](../quick-start.md) and [training](../training.md)
+* Try out the updated [Python and Java SDKs](https://github.com/argoproj/argo-workflows/tree/master/sdks).
+* [Authoring and Submitting Argo Workflows using Python](https://blog.argoproj.io/authoring-and-submitting-argo-workflows-using-python-aff9a070d95f)
+* Head to the [Kubeflow docs](https://www.kubeflow.org/docs/components/pipelines/).
+
+## Videos
+
+* [Machine Learning with Argo and Ploomber](https://www.youtube.com/watch?v=FnpXyg-5W_c&list=PLGHfqDpnXFXK4E8XzasScagiJk-8BPgva&utm_source=argo-docs)
+* [MLOps at Tripadvisor: ML Models CI/CD Automation with Argo - Ang Gao (Principal Software Engineer, TripAdvisor)](https://www.youtube.com/watch?v=BochC4GKxbo&list=PLGHfqDpnXFXK4E8XzasScagiJk-8BPgva&index=2&utm_source=argo-docs)
diff --git a/docs/use-cases/other.md b/docs/use-cases/other.md
@@ -0,0 +1,7 @@
+# Other
+
+## Docs
+
+We don't have any special docs for "other". Try these:
+
+* [Quick start](../quick-start.md) and [training](../training.md)
diff --git a/docs/use-cases/stream-processing.md b/docs/use-cases/stream-processing.md
@@ -0,0 +1,3 @@
+# Stream Processing
+
+Head to the [ArgoLabs Dataflow](https://github.com/argoproj-labs/argo-dataflow) docs.
diff --git a/docs/webhooks.md b/docs/webhooks.md
@@ -1,6 +1,5 @@
 # Webhooks
 
-![alpha](assets/alpha.svg)
 
 > v2.11 and after
 

diff --git a/docs/workflow-executors.md b/docs/workflow-executors.md
@@ -90,8 +90,6 @@ The executor to be used in your workflows can be changed in [the configmap](./wo
 
 ## Emissary (emissary)
 
-![alpha](assets/alpha.svg)
-
 > v3.1 and after
 
 **default in >= v3.3**