Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ export default defineConfig({
{label: 'Quick Start', link: '/automation/getting-started/quick-start'},
],
},
{
label: 'Build Workflows',
items: [
{label: 'Overview', link: '/automation/build_workflows/overview'},
{label: 'Project Guides', link: '/automation/build_workflows/project_guides'}
],
}
],
},
{
Expand Down
8 changes: 8 additions & 0 deletions docs/src/content/docs/automation/build_workflows/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Overview"
description: "An introduction to building and managing projects and workflows in ByteChef."
---

In the following steps, we will learn how to build and manage projects and workflows within ByteChef. Projects and
workflows are essential components of automation, enabling you to organize tasks, streamline processes, and enhance
operational efficiency.
82 changes: 82 additions & 0 deletions docs/src/content/docs/automation/build_workflows/project_guides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: "Projects"
description: "Learn how to create, manage, and organize projects within ByteChef."
---

Every project on ByteChef consists of one or more workflows. Projects help organize and manage workflows, making it
easier to group related automation processes together.

## Creating a Project

1. Navigate to the **Projects** tab.
2. Click on the **New Project** button located in the top right corner.
3. Enter a name for your project. Optionally, provide a description, select a category, and add relevant tags.
4. Click **Save**.

<div style="position:relative;height:0;width:100%;overflow:hidden;z-index:99999;box-sizing:border-box;padding-bottom:calc(51.63511188% + 32px)">
<iframe src="https://www.guidejar.com/embed/yvaNwrCiff9yL75oxQcS?type=1&controls=on" width="100%" height="100%" style="height:100%;position:absolute;inset:0" allowfullscreen frameborder="0"></iframe>
</div>

## Editing a Project

1. Locate the project you wish to edit and click on the three dots next to its name.
2. Select **Edit** from the dropdown menu.
3. Modify the project name, description, category, or tags as needed.
4. Click **Save** to apply your changes.

<div style="position:relative;height:0;width:100%;overflow:hidden;z-index:99999;box-sizing:border-box;padding-bottom:calc(51.63511188% + 32px)">
<iframe src="https://www.guidejar.com/embed/4q7V8ueUNR3AwCr19p3K?type=1&controls=on" width="100%" height="100%" style="height:100%;position:absolute;inset:0" allowfullscreen frameborder="0"></iframe>
</div>

## Duplicating a Project

1. Find the project you want to duplicate and click on the three dots next to its name.
2. Select **Duplicate** from the dropdown menu.
3. The duplicated project will appear in the project list with the same name followed by a numerical suffix (e.g.,
Project Name (1)).

<div style="position:relative;height:0;width:100%;overflow:hidden;z-index:99999;box-sizing:border-box;padding-bottom:calc(51.63511188% + 32px)">
<iframe src="https://www.guidejar.com/embed/4bAqjD5y9nSX4SC9lSWd?type=1&controls=on" width="100%" height="100%" style="height:100%;position:absolute;inset:0" allowfullscreen frameborder="0"></iframe>
</div>

## Creating a Workflow

1. Click on the three dots next to the project name where you want to add a workflow.
2. Select **New Workflow** from the dropdown menu.
3. Enter a label for your workflow and optionally provide a description.
4. Click **Save** to create the workflow.

<div style="position:relative;height:0;width:100%;overflow:hidden;z-index:99999;box-sizing:border-box;padding-bottom:calc(51.63511188% + 32px)">
<iframe src="https://www.guidejar.com/embed/hKXp2J07qDjlTcyz4PJp?type=1&controls=on" width="100%" height="100%" style="height:100%;position:absolute;inset:0" allowfullscreen frameborder="0"></iframe>
</div>

## Import Workflow

1. Click on the three dots next to the project name where you want to import a workflow.
2. Select **Import Workflow** from the dropdown menu.
3. Choose the JSON file containing the workflow you wish to import.

<div style="position:relative;height:0;width:100%;overflow:hidden;z-index:99999;box-sizing:border-box;padding-bottom:calc(51.63511188% + 32px)">
<iframe src="https://www.guidejar.com/embed/3VXegVDeydYISpJxo250?type=1&controls=on" width="100%" height="100%" style="height:100%;position:absolute;inset:0" allowfullscreen frameborder="0"></iframe>
</div>

## Publish Project

1. Click on the three dots next to the project name you wish to publish.
2. Select **Publish** from the dropdown menu.
3. Provide a description for this published version to document any changes or updates.
4. Click **Publish** to make the project available.

<div style="position:relative;height:0;width:100%;overflow:hidden;z-index:99999;box-sizing:border-box;padding-bottom:calc(51.63511188% + 32px)">
<iframe src="https://www.guidejar.com/embed/QTdT12o09JYLf3Ia0veD?type=1&controls=on" width="100%" height="100%" style="height:100%;position:absolute;inset:0" allowfullscreen frameborder="0"></iframe>
</div>

## Delete Project

1. Locate the project you want to delete and click on the three dots next to its name.
2. Select **Delete** from the dropdown menu.
3. Confirm the deletion if prompted.

<div style="position:relative;height:0;width:100%;overflow:hidden;z-index:99999;box-sizing:border-box;padding-bottom:calc(51.63511188% + 32px)">
<iframe src="https://www.guidejar.com/embed/a8FJf631lYiJfSEDeFSn?type=1&controls=on" width="100%" height="100%" style="height:100%;position:absolute;inset:0" allowfullscreen frameborder="0"></iframe>
</div>
4 changes: 4 additions & 0 deletions docs/src/content/docs/automation/getting-started/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Connections are used to connect a component to an external service or applicatio

These are events that initiate a workflow. Triggers listen for specific occurrences, such as receiving a new email, a change in a database, or a scheduled time event, and start the workflow when these events occur.

## Projects

Projects are containers that hold one or more workflows. Projects help organize and manage workflows, making it easier to group related automation processes together. Users can create, edit, duplicate, import, and delete projects to streamline their automation efforts.

## Workflows

Workflows are a series of actions and triggers that automate processes within the ByteChef platform. Workflows can be created by combining various components and configuring them to work together seamlessly. Users can also customize workflows by adding conditions, loops, and other logic to create more complex automation processes.
Expand Down