Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial docs for projects and personal space changes #2575

Merged
2 changes: 1 addition & 1 deletion _snippets/try-it-out/new-workflow.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
When you open n8n, you'll see either:

* An empty workflow: if you have no workflows and you're logging in for the first time. Use this workflow.
* The **Workflows** list on the <span class="inline-image">![Home icon](/_images/common-icons/home.png){.off-glb}</span> **Home** page. Select **Add workflow** to create a new workflow.
* The **Workflows** list on the **Overview** page. Select the <span class="inline-image">![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb}</span> **button** to create a new workflow.
Binary file modified docs/_images/common-icons/home.png
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.
8 changes: 4 additions & 4 deletions docs/code/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ When you create a variable, it's available to everyone on your n8n instance.

To create a new variable:

1. On the **Variables** page, select **Add Variable**.
3. Enter a **Key** and **Value**. The maximum key length is 50 characters, and the maximum value length is 220 characters. n8n limits the characters you can use in the key and value to lowercase and uppercase letters, numbers, and underscores (`A-Z`, `a-z`, `0-9`, `_`).
4. Select **Save**. The variable is now available for use in all workflows in the n8n instance.
1. On the **Variables** page, select **Add Variable**.
2. Enter a **Key** and **Value**. The maximum key length is 50 characters, and the maximum value length is 220 characters. n8n limits the characters you can use in the key and value to lowercase and uppercase letters, numbers, and underscores (`A-Z`, `a-z`, `0-9`, `_`).
3. Select **Save**. The variable is now available for use in all workflows in the n8n instance.

## Edit and delete variables

To edit or delete a variable:

1. On the **Variables** page, hover over the variable you want to change.
1. On the **Variables** page, hover over the variable you want to change.
2. Select **Edit** or **Delete**.

## Use variables in workflows
Expand Down
2 changes: 1 addition & 1 deletion docs/courses/level-one/chapter-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ On the left side of the **Editor UI**, there is a panel which contains the core

The panel contains the following sections:

- <span class="inline-image">![Home icon](/_images/common-icons/home.png){.off-glb}</span> **Home**: Contains all the workflows and credentials you have access to. During this course, create new workflows here.
- **Overview**: Contains all the workflows and credentials you have access to. During this course, create new workflows here.
- **Templates**: A collection of pre-made workflows. Great place to get started with common use cases.
- **Variables**: Used to store and access fixed data across your workflows. This feature is available on the Pro and Enterprise Plans.
- **All executions**: Contains information about your workflow executions.
Expand Down
17 changes: 14 additions & 3 deletions docs/credentials/add-edit-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,21 @@ workflowFile: credentials/dynamic_credentials_using_expressions.json

# Create and edit credentials

You can get to the credential modal by either:
Credentials are securely stored authentication information used to connect n8n workflows to external services such as APIs, or databases.

* Opening the left menu, then selecting either <span class="inline-image">![Home icon](/_images/common-icons/home.png){.off-glb}</span> **Home** or a project, then **Credentials** > **Add Credential** and browsing for the service you want to connect to.
* Selecting **Create New** in the **Credential** dropdown in a node.
## Create a credential

1. Select the <span class="inline-image">![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb}</span> **button** in the upper-left corner of the side menu. Select credential.
2. If your n8n instance supports projects, you'll also need to choose whether to create the credential inside your personal space or a specific project you have access to. If you're using the community version, you'll create the credential inside your personal space.
3. Select the app or service you wish to connect to.

Or:

1. Using the <span class="inline-image">![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb}</span> **Create** button in the upper-right corner from either the **Overview** page or a specific project. Select Credential.
2. If you're doing this from the **Overview** page, you'll create the credential inside your personal space. If you're doing this from inside a project, you'll create the credential inside that specific project.
3. Select the app or service you wish to connect to.

You can also create new credential in the credential drop down when editing a node on the workflow editor.

Once in the credential modal, enter the details required by your service. Refer to your service's page in the [credentials library](/integrations/builtin/credentials/) for guidance.

Expand Down
4 changes: 2 additions & 2 deletions docs/credentials/credential-sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In [projects](/user-management/rbac/), a user's role controls how they can inter

To share a credential:

1. From the left menu, select either <span class="inline-image">![Home icon](/_images/common-icons/home.png){.off-glb}</span> **Home** or a project.
1. From the left menu, select either **Overview** or a project.
2. Select **Credentials** to see a list of your credentials.
3. Select the credential you want to share.
4. Select **Sharing**.
Expand All @@ -36,7 +36,7 @@ To share a credential:

To unshare a credential:

1. From the left menu, select either <span class="inline-image">![Home icon](/_images/common-icons/home.png){.off-glb}</span> **Home** or a project.
1. From the left menu, select either **Overview** or a project.
2. Select **Credentials** to see a list of your credentials.
3. Select the credential you want to unshare.
4. Select **Sharing**.
Expand Down
12 changes: 9 additions & 3 deletions docs/workflows/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,15 @@ A workflow is a collection of nodes connected together to automate a process. Yo

## Create a workflow

1. If your n8n instance has [RBAC and projects](/user-management/rbac/) enabled: select either <span class="inline-image">![Home icon](/_images/common-icons/home.png)</span> **Home** to create a workflow in your own space, or a project to create a workflow and automatically share it with other project members
1. On the **Workflows** list, select **Add Workflow**.
1. Get started by adding a trigger node: select **Add first step...**
1. Select the <span class="inline-image">![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb}</span> **button** in the upper-left corner of the side menu. Select workflow.
2. If your n8n instance supports projects, you'll also need to choose whether to create the workflow inside your **personal space** or a specific **project** you have access to. If you're using the community version, you'll always create workflows inside your personal space.
3. Get started by adding a trigger node: select **Add first step...**

Or:

1. Select the <span class="inline-image">![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb}</span> **create** button in the upper-right corner from either the **Overview** page or a specific **project**. Select workflow.
2. If you're doing this from the **Overview** page, you'll create the workflow inside your personal space. If you're doing this from inside a project, you'll create the workflow inside that specific project.
3. Get started by adding a trigger node: select **Add first step...**

If it's your first time building a workflow, you may want to use the [quickstart guides](/try-it-out/) to quickly try out n8n features.

Expand Down
19 changes: 8 additions & 11 deletions docs/workflows/executions/all-executions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,35 @@ description: View and filter all executions for all workflows.
contentType: howto
---

# All executions list
# All executions

The **All executions** list shows all executions for all workflows you have access to.
To view **all executions** from an n8n instance, navigate to the **Overview** page and then click into the Executions tab. This will show you all executions from the workflows you have access to.

If your n8n instance supports **projects**, you'll also be able to view the executions tab within projects you have access to. This will show you executions only from the workflows within the specified project.

/// note | Deleted workflows
When you delete a workflow, n8n deletes its execution history as well. This means you can't view executions for deleted workflows.
///
## Browse executions

Select **All executions** <span class="inline-image">![All executions menu icon](/_images/common-icons/executions-menu.png){.off-glb}</span> to open the list.


## Filter executions

You can filter the executions list.

You can filter the executions list:

1. Select **All executions** <span class="inline-image">![All executions menu icon](/_images/common-icons/executions-menu.png){.off-glb}</span> to open the list.
1. Select the **Executions** tab either from within the **Overview** page or a specific **project** to open the list.
2. Select **Filters**.
3. Enter your filters. You can filter by:
* **Workflows**: choose all workflows, or a specific workflow name.
* **Status**: choose from **Failed**, **Running**, **Success**, or **Waiting**.
* **Execution start**: see executions that started in the given time.
* **Saved custom data**: this is data you create within the workflow using the Code node. Enter the key and value to filter. Refer to [Custom executions data](/workflows/executions/custom-executions-data/) for information on adding custom data.

--8<-- "_snippets/workflows/executions/custom-execution-data-availability.md"
--8<-- "_snippets/workflows/executions/custom-execution-data-availability.md"

## Retry failed workflows

If your workflow execution fails, you can retry the execution. To retry a failed workflow:

1. Select **All executions** <span class="inline-image">![All executions menu icon](/_images/common-icons/executions-menu.png){.off-glb}</span> to open the list.
1. Select the **Executions** tab from within either the **Overview** page or a specific **project** to open the list.
2. On the execution you want to retry, select **Retry execution** <span class="inline-image">![Options menu icon](/_images/common-icons/three-dot-options-menu.png){.off-glb}</span>.
--8<-- "_snippets/workflows/executions/retry-options.md"

Expand Down
2 changes: 1 addition & 1 deletion docs/workflows/sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Users can share workflows they created. Instance owners, and users with the admi

You can browse and search workflows on the **Workflows** list. The workflows in the list depend on the project:

* **Home** lists all workflows you can access. This includes:
* **Overview** lists all workflows you can access. This includes:
* Your own workflows.
* Workflows shared with you.
* Workflows in projects you're a member of.
Expand Down