Skip to content

Commit

Permalink
Merge pull request #29 from Tauffer-Consulting/fix-text
Browse files Browse the repository at this point in the history
text and remove old files
  • Loading branch information
vinicvaz authored Apr 11, 2024
2 parents 095d955 + f97dab5 commit 730114c
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 153 deletions.
19 changes: 11 additions & 8 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Icon } from '@iconify/react'

# What is Domino?

Domino is an open source platform for creating and monitoring advanced workflows, with:
Domino is an open source platform for creating and monitoring advanced data workflows, with:

<p
style={{
Expand Down Expand Up @@ -60,26 +60,29 @@ Domino is an open source platform for creating and monitoring advanced workflows
</div>
</p>

Creating workflows in the GUI is as simple as dragging and dropping Pieces to the canvas and connecting them. The user can also schedule the Workflow to run periodically, at a specific date/time, or trigger it manually.

### Data workflows at your fingertips

Creating workflows in the GUI is as simple as dragging and dropping Pieces to the canvas and connecting them. The user can schedule the workflow to run periodically, at a specific date/time, or trigger it manually.

![Domino create workflow](/img/intro/create-workflow.gif)


The monitoring page shows the status of each Workflow task in real time, including the informative logs and visual results for each run.
The monitoring page shows the status of each workflow task in real time, including the informative logs and visual results for each run.

![Domino create workflow](/img/domino_components/gui/run-workflow.gif)


### Domino vs Apache Airflow

Every Domino Workflow corresponds to an Apache Airflow DAG, and each Piece corresponds to an Airflow task. Domino controls an Airflow instance, which is responsible for executing, scheduling and monitoring the Workflows (DAGs).
Every Domino workflow corresponds to an Apache Airflow DAG, and each Piece corresponds to an Airflow task. Domino controls an Airflow instance, which is responsible for executing, scheduling and monitoring the workflows (DAGs).

You can think of Domino as Airflow with superpowers, where users can:

- create highly complex Workflows with simple point-and-click and drag-and-drop operations, in an user-friendly GUI
- create highly complex workflows with simple point-and-click and drag-and-drop operations, in an user-friendly GUI
- make use of Pieces developed by other people, share and reuse your own Pieces
- collaborate in groups to edit and monitor Workflows
- experience a cleaner and more intuitive GUI for viewing Workflows results, including logs and richer reports with images and tables
- collaborate in groups to edit and monitor workflows
- experience a cleaner and more intuitive GUI for viewing workflows results, including logs and richer reports with images and tables


### Development
Expand All @@ -91,7 +94,7 @@ Domino is a modular and open source software, which allows for contributions fro
- Frontend is written in React / Typescript
- REST API written in Python with FastAPI
- Worflows management is performed by Apache Airflow
- GitOps approach to host and version Pieces and Workflows
- GitOps approach to host and version Pieces and workflows
- Pieces data models are defined with Pydantic
- Pieces are built and distributed as Docker images, hosted in public repositories such as Github Container Registry
- Domino runs on Kubernetes, both in the cloud or locally (using Kind)
Expand Down
14 changes: 7 additions & 7 deletions docs/quickstart/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ To return to this page in the future, click on the **Workspaces** button, the fi
![Select workspace](/img/quickstart/select-workspace.png)


### Starting a workflow
### Building a workflow

Time to create your first Domino workflow! Click on the **Workflow Editor** button, the third on the left side navigation bar, to open the Workflow Editor page.
Time to build your first Domino workflow! Click on the **Workflow Editor** button, the third on the left side navigation bar, to open the Workflow Editor page.

This is the space where you will put your ideas into reality. You can drag and drop Pieces from the right side bar to the canvas, connect them and configure them to create any workflow.
This is the space where you will turn your ideas into reality. You can drag and drop Pieces from the right side bar to the canvas, connect them and configure them to create any workflow.

For an easy start, click the **Import** button and then **from examples gallery**. Here you will find a few examples of workflows with different levels of complexity that you can use to learn Domino.

Expand Down Expand Up @@ -152,7 +152,7 @@ When creating a workflow you should configure its Settings and Pieces arguments.
</Tabs>


### Creating a Workflow
### Creating a workflow
Now that your workflow is configured, you can create it just by clicking on the Create button.

:::info
Expand All @@ -165,7 +165,7 @@ Next, you can go to **My Workflows** page, where you can monitor all your workfl
![Create Workflow](/img/quickstart/create_workflow.gif)


### Running and Monitoring a Workflow
### Running and Monitoring workflows
Now your workflow is active and ready to run. Even if you've set up a schedule, you can always manually trigger a new workflow run, simply click the **Run** button directly in the workflows table, or select the desired workflow and, once in the workflows individual page, click the **Run** button.

By selecting the desired workflow, you'll be directed to the workflow's individual monitoring page. This page provides a comprehensive view, allowing you to follow the overall status of your workflow, as well as specific Pieces logs and real-time results!
Expand All @@ -174,10 +174,10 @@ By selecting the desired workflow, you'll be directed to the workflow's individu
- The bottom graph visualizes the real-time progress during execution or its final state after the run completion.
- For detailed monitoring of each Piece, including access to logs and results, simply double-click on the desired piece and navigate to the section on the right.

![Monitoring Workflow](/img/quickstart/monitoring_workflow.gif)
![Monitoring workflow](/img/quickstart/monitoring_workflow.gif)


Congratulations! You just went from starting the Domino's platform to creating your first workflow!
Congratulations! You just went from starting the Domino's platform to creating and running your first workflow!

### What's Next?
Your Domino journey is just starting! Check the [Domino Settings](/settings) section to delve deeper into concepts such as Piece Repositories, Secrets, Local and Remote Shared Storage, and more!
Binary file removed static/img/favicon.ico
Binary file not shown.
Binary file removed static/img/logo.png
Binary file not shown.
138 changes: 0 additions & 138 deletions static/img/logo.svg

This file was deleted.

Binary file removed static/img/logo_cropped.jpg
Binary file not shown.

0 comments on commit 730114c

Please sign in to comment.