Skip to content

Commit

Permalink
feat: add docId for in-app docs (#2046)
Browse files Browse the repository at this point in the history
* feat: add docId for in-app docs

* docId: flowEditor
  • Loading branch information
anna-geller authored Jan 6, 2025
1 parent 9f91a35 commit 9682945
Show file tree
Hide file tree
Showing 22 changed files with 36 additions and 4 deletions.
3 changes: 2 additions & 1 deletion content/docs/01.getting-started/09.plugins.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Plugins
icon: /docs/icons/plugins.svg
docId: plugins
---

Browse [Kestra's integrations](/plugins) and learn how to create your own plugins.
Expand All @@ -13,4 +14,4 @@ Kestra comes prepackaged with hundreds of [plugins](/plugins), and you can also

## Custom Plugins

To integrate with your internal systems and processes, you can build custom plugins. If you think it could be useful to others, consider contributing your plugin to our open-source community. Check out more on in [Plugins Developer Guide](../plugin-developer-guide/index.md).
To integrate with your internal systems and processes, you can [build custom plugins](../plugin-developer-guide/index.md). If you think it could be useful to others, consider [contributing it](../01.getting-started/16.contributing.md) to our open-source community.
1 change: 1 addition & 0 deletions content/docs/04.workflow-components/01.flow.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Flow
icon: /docs/icons/flow.svg
docId: flows
---

Flow is a container for tasks and their orchestration logic.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Task Runs
icon: /docs/icons/flow.svg
docId: taskruns
---

A Task Run is a single run of an individual task within an [Execution](../03.execution.md), where an Execution is a single run of a flow. This means an Execution can have many Task Runs.
Expand Down
1 change: 1 addition & 0 deletions content/docs/04.workflow-components/02.namespace.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Namespace
icon: /docs/icons/flow.svg
docId: namespaces
---

Namespace is a logical grouping of flows.
Expand Down
1 change: 1 addition & 0 deletions content/docs/04.workflow-components/03.execution.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Execution
icon: /docs/icons/flow.svg
docId: executions
---

Execute your flows and view the outcome.
Expand Down
1 change: 1 addition & 0 deletions content/docs/04.workflow-components/04.variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Variables
icon: /docs/icons/flow.svg
docId: variables
---

Variables are key-value pairs that help reuse some values across tasks.
Expand Down
3 changes: 2 additions & 1 deletion content/docs/04.workflow-components/07.triggers/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Triggers
icon: /docs/icons/flow.svg
docId: triggers
---

Trigger is a mechanism that automates the execution of a flow.
Expand Down Expand Up @@ -259,7 +260,7 @@ Let's break down the above example:

To see a list of triggers and inspect their current status, go to the **Administration -> Triggers** section in the Kestra UI. From here, you can unlock a trigger if it is locked. Keep in mind that there is a risk or concurrent trigger evaluation or flow execution for this trigger if you unlock it manually.

## Setting inputs inside of triggers
## Setting inputs inside of triggers

You can easily pass inputs to triggers by using the `inputs` property and passing them as a key-value pair.

Expand Down
1 change: 1 addition & 0 deletions content/docs/04.workflow-components/09.plugin-defaults.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Plugin Defaults
icon: /docs/icons/flow.svg
docId: plugin-defaults
---

Plugin defaults are a list of default values applied to each task of a certain type within your flow(s).
Expand Down
1 change: 1 addition & 0 deletions content/docs/05.concepts/05.kv-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Key Value (KV) Store
icon: /docs/icons/concepts.svg
version: ">= 0.18.0"
docId: kv
---

Build stateful workflows with the KV Store.
Expand Down
1 change: 1 addition & 0 deletions content/docs/05.concepts/07.blueprints.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Blueprints
icon: /docs/icons/concepts.svg
version: ">= 0.10.0"
docId: blueprints
---

Ready-to-use examples designed to kickstart your workflow.
Expand Down
11 changes: 11 additions & 0 deletions content/docs/05.concepts/editor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Editor
icon: /docs/icons/concepts.svg
docId: flowEditor
---

Kestra provides a built-in code editor to write and test your flows.

The **Flow Editor** is a simple text editor that provides syntax highlighting and auto-completion for YAML flow definitions.

Using the `Files` button, you can open a sidebar allowing you to add, edit, import or export [Namespace Files](./02.namespace-files.md).
1 change: 1 addition & 0 deletions content/docs/06.enterprise/03.tenants.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Tenants
icon: /docs/icons/admin.svg
editions: ["EE"]
version: ">= 0.13.0"
docId: tenants
---

How to enable multi-tenancy in your Kestra instance.
Expand Down
1 change: 1 addition & 0 deletions content/docs/06.enterprise/06.audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Audit Logs
icon: /docs/icons/admin.svg
editions: ["EE"]
docId: audit-logs
---

How to use Audit Logs to govern activities in your Kestra instance.
Expand Down
1 change: 1 addition & 0 deletions content/docs/06.enterprise/07.namespace-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Namespace Management
icon: /docs/icons/admin.svg
editions: ["EE"]
docId: edit
---

How to govern secrets, variables and plugin defaults on a namespace level.
Expand Down
5 changes: 3 additions & 2 deletions content/docs/06.enterprise/apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Apps
icon: /docs/icons/kestra.svg
editions: ["EE"]
version: ">= 0.20.0"
docId: apps
---

Build custom UIs to interact with Kestra from the outside world.
Expand All @@ -13,9 +14,9 @@ Build custom UIs to interact with Kestra from the outside world.

## Overview

Apps let you use your Kestra workflows as the backend for custom applications. Within each app, you can specify custom frontend blocks, such as forms for data entry, output displays, approval buttons, or markdown blocks.
Apps let you use your Kestra workflows as the backend for custom applications. Within each app, you can specify custom frontend blocks, such as forms for data entry, output displays, approval buttons, or markdown blocks.

**Flows** act as the **backend**, processing data and executing tasks, while **Apps** serve as **frontend**, allowing anyone to interact with your workflows regardless of their technical background.
**Flows** act as the **backend**, processing data and executing tasks, while **Apps** serve as **frontend**, allowing anyone to interact with your workflows regardless of their technical background.

Business users can trigger new workflow executions, manually approve workflows that are paused, submit data to automated processes using simple forms, and view the execution results.

Expand Down
1 change: 1 addition & 0 deletions content/docs/06.enterprise/custom-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Custom Dashboards
icon: /docs/icons/kestra.svg
editions: ["EE", "Beta"]
version: ">= 0.20.0"
docId: default
---

Build custom dashboards to visualize your executions, logs and metrics.
Expand Down
1 change: 1 addition & 0 deletions content/docs/06.enterprise/invitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Invitations
icon: /docs/icons/admin.svg
editions: ["EE"]
version: ">= 0.20.0"
docId: users
---

Add new users to your tenant or instance by using the invitation process.
Expand Down
1 change: 1 addition & 0 deletions content/docs/06.enterprise/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Role-Based Access Control (RBAC)
icon: /docs/icons/admin.svg
editions: ["EE"]
docId: bindings
---

How to manage access and permissions to your instance.
Expand Down
1 change: 1 addition & 0 deletions content/docs/06.enterprise/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Secrets
icon: /docs/icons/kestra.svg
editions: ["EE"]
docId: secrets
---

How to create and manage Secrets in the Enterprise Edition.
Expand Down
1 change: 1 addition & 0 deletions content/docs/08.ui/03.logs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Logs
icon: /docs/icons/ui.svg
docId: logs
---

Manage Logs generated by tasks.
Expand Down
1 change: 1 addition & 0 deletions content/docs/08.ui/06.settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Settings
icon: /docs/icons/ui.svg
docId: settings
---

Configure Settings for Kestra.
Expand Down
1 change: 1 addition & 0 deletions content/docs/08.ui/07.administration/02.stats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Stats
icon: /docs/icons/ui.svg
docId: stats
---

Manage Stats in Kestra.
Expand Down

0 comments on commit 9682945

Please sign in to comment.