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.

Sign up for GitHub

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

Update quick quickstart #2918

Merged
merged 2 commits into from
Feb 27, 2025
Merged

Update quick quickstart #2918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f332d51
Update quick quickstart
imchairmanm Feb 27, 2025
9cb71b7
Update very-quick-quickstart-workflow.json
imchairmanm Feb 27, 2025
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
4 changes: 0 additions & 4 deletions _snippets/try-it-out/install-run-n8n.md
View file
Open in desktop

This file was deleted.

Binary file removed docs/_images/try-it-out/quickstart/very-quick-quickstart-workflow.png
View file
Open in desktop
Binary file not shown.
147 changes: 147 additions & 0 deletions docs/_workflows/try-it-out/quickstart/very-quick-quickstart-workflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
{
"nodes": [
{
"parameters": {
"operation": "getAllPeople",
"returnAll": true
},
"id": "ed1fd9cd-cc4f-4e0e-ba73-9f842db382c3",
"name": "Customer Datastore",
"type": "n8n-nodes-base.n8nTrainingCustomerDatastore",
"position": [
540,
280
],
"typeVersion": 1
},
{
"parameters": {
"content": "**Get fake sample data**",
"height": 300,
"width": 220
},
"id": "5ddf393f-62b8-4240-adf8-f9a8f539df4b",
"name": "Note1",
"type": "n8n-nodes-base.stickyNote",
"position": [
480,
180
],
"typeVersion": 1
},
{
"parameters": {
"content": "**Extract data and prepare it for use in the next node**",
"height": 300,
"width": 220
},
"id": "6ad194ea-9821-40eb-ae2c-f50cc030300b",
"name": "Note2",
"type": "n8n-nodes-base.stickyNote",
"position": [
760,
180
],
"typeVersion": 1
},
{
"parameters": {},
"id": "5af4b83b-31b6-4c29-aa55-3449f3851e2a",
"name": "When clicking \"Test Workflow\"",
"type": "n8n-nodes-base.manualTrigger",
"position": [
300,
280
],
"typeVersion": 1
},
{
"parameters": {
"assignments": {
"assignments": [
{
"id": "df041e3c-fc09-4ba2-8e6b-37f2c6a02526",
"name": "customer_id",
"type": "string",
"value": "={{ $json.id }}"
},
{
"id": "bf288953-4fef-4f55-a45f-c223714919c0",
"name": "customer_name",
"type": "string",
"value": "={{ $json.name }}"
},
{
"id": "1cff0b21-6740-4697-9d2c-9bcb045af0be",
"name": "customer_description",
"type": "string",
"value": "={{ $json.notes }}"
}
]
},
"options": {}
},
"id": "5dcd5776-5137-4f97-8b76-9f38e1d9ff9e",
"name": "Edit Fields1",
"type": "n8n-nodes-base.set",
"position": [
820,
280
],
"typeVersion": 3.3
},
{
"parameters": {
"customerId": "={{ $json.customer_id }}",
"message": "=Hi {{ $json.customer_name }}. Your description is: {{ $json.customer_description }}"
},
"type": "n8n-nodes-base.n8nTrainingCustomerMessenger",
"typeVersion": 1,
"position": [
1040,
280
],
"id": "a726dcfd-f491-440f-ad64-6ba17472352f",
"name": "Customer Messenger (n8n training)"
}
],
"connections": {
"Customer Datastore": {
"main": [
[
{
"node": "Edit Fields1",
"type": "main",
"index": 0
}
]
]
},
"When clicking \"Test Workflow\"": {
"main": [
[
{
"node": "Customer Datastore",
"type": "main",
"index": 0
}
]
]
},
"Edit Fields1": {
"main": [
[
{
"node": "Customer Messenger (n8n training)",
"type": "main",
"index": 0
}
]
]
}
},
"pinData": {},
"meta": {
"instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7"
}
}
2 changes: 1 addition & 1 deletion docs/try-it-out/longer-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This guide shows you how to automate a task using a [workflow](/glossary.md#work

## Step one: Sign up for n8n

--8<-- "_snippets/try-it-out/install-run-n8n.md"
This quickstart uses [n8n Cloud](/manage-cloud/overview.md). A free trial is available for new users. If you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now.

## Step two: New workflow

Expand Down
25 changes: 13 additions & 12 deletions docs/try-it-out/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,32 @@

# The very quick quickstart

This quickstart gives you a quick taste of n8n. Its aim is to allow you to try out the UI, and introduce you to two key features: workflow templates and [expressions](/glossary.md#expression-n8n). It doesn't include detailed explanations or explore concepts.
This quickstart gets you started using n8n as quickly as possible. Its allows you to try out the UI and introduces two key features: [workflow templates](/glossary.md#template-n8n) and [expressions](/glossary.md#expression-n8n). It doesn't include detailed explanations or explore concepts in-depth.

Check warning on line 9 in docs/try-it-out/quickstart.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Weasel] 'quickly' is a weasel word!

Raw Output:
{"message": "[from-write-good.Weasel] 'quickly' is a weasel word!", "location": {"path": "docs/try-it-out/quickstart.md", "range": {"start": {"line": 9, "column": 47}}}, "severity": "WARNING"}

Check warning on line 9 in docs/try-it-out/quickstart.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-microsoft.Adverbs] Consider removing 'quickly'.

Raw Output:
{"message": "[from-microsoft.Adverbs] Consider removing 'quickly'.", "location": {"path": "docs/try-it-out/quickstart.md", "range": {"start": {"line": 9, "column": 47}}}, "severity": "WARNING"}

You will:
In this tutorial, you will:

* Load a [workflow](/glossary.md#workflow-n8n) from the workflow templates library
* Add a node and configure it using expressions.
* Add a node and configure it using expressions
* Run your first workflow

## Step one: Sign up for n8n

--8<-- "_snippets/try-it-out/install-run-n8n.md"
This quickstart uses [n8n Cloud](/manage-cloud/overview.md). A free trial is available for new users. If you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now.

## Step two: Open a workflow template

n8n provides a quickstart [template](/glossary.md#template-n8n) using training nodes. This allows you to work with fake data, and avoids setting up [credentials](/glossary.md#credential-n8n).
n8n provides a quickstart template using training nodes. You can use this to work with fake data and avoid setting up [credentials](/glossary.md#credential-n8n).

1. Go to [Templates | Very quick quickstart](https://n8n.io/workflows/1700-very-quick-quickstart/){:target=_blank .external-link}.
1. Go to [Templates | Very quick quickstart](https://n8n.io/workflows/1700-very-quick-quickstart/).

Check warning on line 25 in docs/try-it-out/quickstart.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-microsoft.Adverbs] Consider removing 'Very'.

Raw Output:
{"message": "[from-microsoft.Adverbs] Consider removing 'Very'.", "location": {"path": "docs/try-it-out/quickstart.md", "range": {"start": {"line": 25, "column": 23}}}, "severity": "WARNING"}

Check warning on line 25 in docs/try-it-out/quickstart.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Weasel] 'Very' is a weasel word!

Raw Output:
{"message": "[from-write-good.Weasel] 'Very' is a weasel word!", "location": {"path": "docs/try-it-out/quickstart.md", "range": {"start": {"line": 25, "column": 23}}}, "severity": "WARNING"}
1. Select **Use workflow** to view the options for using the template.
1. Select **Import template to <name> cloud workspace** to load the template into your Cloud instance.

This workflow:

1. Gets example data from the Customer Datastore node.
2. Uses the Edit Fields node to extract just the data you want, and assign that data to variables. In this example, you use the customer name, ID, and description.
1. Gets example data from the [Customer Datastore](/integrations/builtin/app-nodes/n8n-nodes-base.n8ntrainingcustomerdatastore.md) node.
2. Uses the [Edit Fields](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node to extract only the desired data and assigns that data to variables. In this example, you map the customer name, ID, and description.

The individual pieces in an n8n workflow are called nodes. Double click a node to explore its settings and how it processes data.
The individual pieces in an n8n workflow are called [nodes](/glossary.md#node-n8n). Double click a node to explore its settings and how it processes data.

Check warning on line 34 in docs/try-it-out/quickstart.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Passive] 'are called' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[from-write-good.Passive] 'are called' may be passive voice. Use active voice if you can.", "location": {"path": "docs/try-it-out/quickstart.md", "range": {"start": {"line": 34, "column": 42}}}, "severity": "WARNING"}

## Step three: Run the workflow

Expand All @@ -45,18 +45,19 @@
2. Search for **Customer Messenger**. n8n shows a list of nodes that match the search.
3. Select **Customer Messenger (n8n training)** to add the node to the [canvas](/glossary.md#canvas-n8n). n8n opens the node automatically.
4. Use [expressions](/code/expressions.md) to map in the **Customer ID** and create the **Message**:
1. Drag **customer_id** from the **INPUT** panel into the **Customer ID** field in the node settings.
1. In the **INPUT** panel select the **Schema** tab.
2. Drag **Edit Fields1** > **customer_id** into the **Customer ID** field in the node settings.
2. Hover over **Message**. Select the **Expression** tab, then select the expand button <span class="inline-image">![Add node icon](/_images/common-icons/open-expression-editor.png){.off-glb}</span> to open the full expressions editor.
3. Copy this expression into the editor:
```
Hi {{$json.customer_name}}, Your description is {{$json.customer_description}}
Hi {{ $json.customer_name }}. Your description is: {{ $json.customer_description }}
```
5. Close the expressions editor, then close the **Customer Messenger** node by clicking outside the node or selecting **Back to canvas**.
6. Select **Test Workflow**. n8n runs the workflow.

The complete workflow should look like this:

![Screenshot of completed quickstart workflow](/_images/try-it-out/quickstart/very-quick-quickstart-workflow.png)
[[ workflowDemo("file:///try-it-out/quickstart/very-quick-quickstart-workflow.json") ]]


## Next steps
Expand Down