Skip to content

Commit

Permalink
doc/blueprints (#337)
Browse files Browse the repository at this point in the history
* doc/blueprints

* doc numbered

* doc nitpick "Create"
  • Loading branch information
anna-geller authored Jul 4, 2023
1 parent 02c5329 commit a10ece1
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 0 deletions.
59 changes: 59 additions & 0 deletions content/docs/04.user-interface-guide/blueprints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Blueprints
---

Blueprints is a curated, organized, and searchable catalog of ready-to-use examples designed to help you kickstart your workflow. Each Blueprint combines code and documentation and can be assigned several tags for organization and discoverability.

All Blueprints are validated and documented. You can easily customize and integrate them into your new or existing flows with a single click on the "Use" button.

![Blueprint](/docs/user-interface-guide/blueprints.png)

## Community Blueprints

We refer to all Blueprints available in the open-source product as Community Blueprints, as they are guided by the community feedback and represent common usage patterns we see among open-source users and contributors.

Community Blueprints are particularly helpful when you're getting started with a new use case, integration, or with Kestra in general because they reflect fairly standardized workflow patterns. All Blueprints are verified by the Kestra team, but everyone is welcome to contribute new Blueprints or suggest improvements to the existing ones using [the following GitHub issue template](https://github.com/kestra-io/kestra/issues/new?assignees=&labels=blueprint&projects=&template=blueprint.yml).

### Where to find Blueprints

Blueprints are accessible from two places in the UI: 

1. The left navigation sidebar 
2. A dedicated tab in the code editor named "Source and blueprints", showing your source code and Blueprints side by side.

![Blueprint UI](/docs/user-interface-guide/blueprints2.png)


### How to find the right Blueprint

Once you are on the Blueprints page, you can:

- **Search** Blueprints for a specific use case or integration, e.g., Snowflake, BigQuery, DuckDB, Slack, ETL, ELT, Pandas, GPU, Git, Python, Docker, Redis, MongoDB, dbt, Airbyte, Fivetran, etc.
- **Filter** by a tag, e.g., filter for Docker, to see various ways to run containers in your flow. Or filter for Notifications to see several options for configuring alerts on success or failure.


## Organization Blueprints

::alert{type="warning"}
This is an [Enterprise Edition](https://kestra.io/enterprise) feature.
::

Apart from Community Blueprints, you can also create custom Blueprints available only to your organization. You can use them to share, centralize, and document commonly used workflows in your team.

You can think of Organization Blueprints as your company's internal App Store, offering a wide range of integrations and validated workflow patterns tailored to your needs.

### How to create a new Organization Blueprint

From the left navigation menu, go to Blueprints. Then, select the Organization Blueprints tab. Click on "Create".

![Organization Blueprints](/docs/user-interface-guide/blueprint-org.png)

Add a title, description, and the contents of the flow. You can add as many tags as you want. Then click on the "Create" button.

![New Organization Blueprint](/docs/user-interface-guide/blueprint-org-2.png)

You can edit the Blueprint anytime, for example, to add new tasks or expand the documentation.

This feature significantly helps code reusability and facilitates collaboration within a team because sharing your code and documentation is finally painless.

Once you reach a certain scale with many internal Blueprints, the search and filtering by tags will ensure that your Blueprints remain easy to find.
1 change: 1 addition & 0 deletions content/docs/04.user-interface-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ On the left menu, you will have access to all the functionalities provided by th
- [Templates](./03-templates.md): The **Templates** page allows flow template management.
- [Executions](./04-executions.md): The **Executions** page allows flow execution management.
- [Logs](./05-logs.md): The **Logs** page allows access to all task logs.
- [Blueprints](./blueprints.md): The **Blueprints** page provides a catalog of ready-to-use flow examples.
- [Documentations](./06-documentations.md): The **Documentations** page allows access to various documentation pages.
- [Settings](./07-settings.md): The **Settings** page allows configuring the Kestra UI.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/user-interface-guide/blueprints.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/user-interface-guide/blueprints2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit a10ece1

@vercel
Copy link

@vercel vercel bot commented on a10ece1 Jul 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

kestra-io – ./

kestra-io-kestra.vercel.app
kestra-io-git-main-kestra.vercel.app
kestra-io.vercel.app

Please sign in to comment.