From e0e1115eb9b22678c8a110250a46bd2ef20ff71f Mon Sep 17 00:00:00 2001 From: Justin Ellingwood Date: Mon, 25 Nov 2024 13:58:04 +0100 Subject: [PATCH] Initial docs for projects and personal space changes (#2575) Co-authored-by: Jonathan Clift --- _snippets/try-it-out/new-workflow.md | 2 +- docs/_images/common-icons/home.png | Bin 557 -> 935 bytes .../universal-resource-button.png | Bin 0 -> 520 bytes docs/code/variables.md | 8 ++++---- docs/courses/level-one/chapter-1.md | 2 +- docs/credentials/add-edit-credentials.md | 17 +++++++++++++--- docs/credentials/credential-sharing.md | 4 ++-- docs/workflows/create.md | 12 ++++++++--- docs/workflows/executions/all-executions.md | 19 ++++++++---------- docs/workflows/sharing.md | 2 +- 10 files changed, 40 insertions(+), 26 deletions(-) create mode 100644 docs/_images/common-icons/universal-resource-button.png diff --git a/_snippets/try-it-out/new-workflow.md b/_snippets/try-it-out/new-workflow.md index d856b646f..c8ec478e4 100644 --- a/_snippets/try-it-out/new-workflow.md +++ b/_snippets/try-it-out/new-workflow.md @@ -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 ![Home icon](/_images/common-icons/home.png){.off-glb} **Home** page. Select **Add workflow** to create a new workflow. +* The **Workflows** list on the **Overview** page. Select the ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **button** to create a new workflow. diff --git a/docs/_images/common-icons/home.png b/docs/_images/common-icons/home.png index d0fd61a94bc54cd2625c1a0989cf46e1ae27361e..ea0f4945fc164b683ba1bbad544bcd9bdf14fdb6 100644 GIT binary patch literal 935 zcmV;Y16cftP)f6sePPM}Siq8)f4T9o0OGW@u3n`|Nz1`1V%Rv3CSP|&j3G+DK2 zW{fNy%~zFy*Sk<;OoTZE={7bdog)ff_(88k1`ffZOHD3va&jIoOuD3-ZQ70bT%G6t zeEgpC^1kOiqN?03v)5V>izTJ< zAl=tZpH*SeiHX5rk2?qKX_IT$9`#u}=zblYm>9e%*l0YtQ#?}wwk)+qi;<#cqQ0%8)SHR*t+}P zjTw-)+vEjAU!2Juxgf}U3h#~`OdO4bg3+s$+Pq*s2fb@05P-Cwv$3)C9ay#FAkVa= zeD7P{3qjStT(v(IWvCTV;R{E+S3ED!uZEMLk9G{$a2_ZYQ-8LErDc3;{Ln@$cdiq} zXBM>`R^8URZ=Y`m{W~c`u5Vv7M(ju^uw6tyX$udi<(A^{#O4mzXnb$0?y;||M7js8m6?g~mo3ZpS~tMGh(uk+*L-|h!0jI08=k$qHMTo~<%3_K*tN#LHQK5vZb9-s_dw59%pc+TZ= z)%|LnAb>Y}`v%V1>Rd7EJPvvusL-&6O+G(0A28nLNXU6Qo6Y{Nmb)Ki*E&Hh+u`B9 zkuI0m`0005ZNkl)lD8ZHzAJ>0}u>Fh$#tNu6x#C-+ycnQxase8XZsC>GQY=h9Us?eNS2VU}J6l zt0_!4o#yh#72dvI1fbXBruorBqVZXNZ~p<{jkGUWH7<#NQ8ISj*~tFr^2x1Wk*Q&!Wk+iQ9K zYJ_|tPbfTD1_ID^oltm^LZN^>`VzanmQ*@Zda}J#ilf6La{52UCxWJTa#n8wGLl$L z)r~6Z9FCI!>KqOLlIm93qT}>blb+MrP^>G;x+b8pfXrAxKKDsjhFwM`u*=MSsaG)j vHInLPu|7S_J3G5*2M5L81K0hFVOQ0EvzM^U#+&1700000NkvXXu0mjf`Kke7 diff --git a/docs/_images/common-icons/universal-resource-button.png b/docs/_images/common-icons/universal-resource-button.png new file mode 100644 index 0000000000000000000000000000000000000000..67e6f1d372835116e41a7e6ddd39acae384e5e29 GIT binary patch literal 520 zcmeAS@N?(olHy`uVBq!ia0vp^#z1Vs!3HGNmoQ8MQk(@Ik;M!Qd`Cc-ajG_-G*FPe z#M9T6{W+&JkCC~cmvue^1LJZ}7srr{#<#N$dNDal9RDx9oBbG}3hPi#WV+!f3nE?Sav(6&x_vRPqOQP1DKcc1Qf zcGvjuMTx1eWFtA{oUa#_R&EsewASbHCd2Yr8CkgnA!if?`(1^MI!>0fRV{A4zP;Q; zSNiE^V}?8PGRtKc6m*#wIxBdVCh;B6GCpu}!>2_$hY}?BMmw#_Tb8n75e$8Ldqro~ z@8jtfdl?xH_^1Y+NOzvC{bg!l6?4g4yIp?r{Qmk2va)RbJMA-Rep^X$EE(k@G* zqOJ87<#JCHa literal 0 HcmV?d00001 diff --git a/docs/code/variables.md b/docs/code/variables.md index 520d87269..e3ccf394a 100644 --- a/docs/code/variables.md +++ b/docs/code/variables.md @@ -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 diff --git a/docs/courses/level-one/chapter-1.md b/docs/courses/level-one/chapter-1.md index 9b26a2126..ba81a840b 100644 --- a/docs/courses/level-one/chapter-1.md +++ b/docs/courses/level-one/chapter-1.md @@ -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: -- ![Home icon](/_images/common-icons/home.png){.off-glb} **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. diff --git a/docs/credentials/add-edit-credentials.md b/docs/credentials/add-edit-credentials.md index 39273d932..7ed06670f 100644 --- a/docs/credentials/add-edit-credentials.md +++ b/docs/credentials/add-edit-credentials.md @@ -6,10 +6,21 @@ contentType: howto # 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 ![Home icon](/_images/common-icons/home.png){.off-glb} **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 ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **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 ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **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. diff --git a/docs/credentials/credential-sharing.md b/docs/credentials/credential-sharing.md index df8093972..e2bf10295 100644 --- a/docs/credentials/credential-sharing.md +++ b/docs/credentials/credential-sharing.md @@ -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 ![Home icon](/_images/common-icons/home.png){.off-glb} **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**. @@ -36,7 +36,7 @@ To share a credential: To unshare a credential: -1. From the left menu, select either ![Home icon](/_images/common-icons/home.png){.off-glb} **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**. diff --git a/docs/workflows/create.md b/docs/workflows/create.md index b3bc1d3f8..21b2c856b 100644 --- a/docs/workflows/create.md +++ b/docs/workflows/create.md @@ -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 ![Home icon](/_images/common-icons/home.png) **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 ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **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 ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **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. diff --git a/docs/workflows/executions/all-executions.md b/docs/workflows/executions/all-executions.md index fa4758585..9f2c5f3d4 100644 --- a/docs/workflows/executions/all-executions.md +++ b/docs/workflows/executions/all-executions.md @@ -4,24 +4,21 @@ 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** ![All executions menu icon](/_images/common-icons/executions-menu.png){.off-glb} to open the list. - ## Filter executions -You can filter the executions list. +You can filter the executions list: - -1. Select **All executions** ![All executions menu icon](/_images/common-icons/executions-menu.png){.off-glb} 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. @@ -29,13 +26,13 @@ You can filter the executions list. * **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** ![All executions menu icon](/_images/common-icons/executions-menu.png){.off-glb} 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** ![Options menu icon](/_images/common-icons/three-dot-options-menu.png){.off-glb}. --8<-- "_snippets/workflows/executions/retry-options.md" diff --git a/docs/workflows/sharing.md b/docs/workflows/sharing.md index 839f3fd24..bad537e1a 100644 --- a/docs/workflows/sharing.md +++ b/docs/workflows/sharing.md @@ -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.