diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 65036abe9..5effa6a4b 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -65,17 +65,17 @@ module.exports = { text: 'Getting Started', link: '/', }, - { - text: 'Guides', - link: '/guides/guides.md' - }, + // { + // text: 'Guides', + // link: '/guides/guides.md' + // }, { text: 'Nodes', - link: '/nodes/nodes.md' + link: '/nodes/nodes.md', }, { text: 'Reference', - link: '/reference/reference.md' + link: '/reference/reference.md', }, { text: 'Community', @@ -83,27 +83,27 @@ module.exports = { }, ], sidebar: { - '/guides/': [ - { - title: 'Guide Overview', - sidebarDepth: 2, - children: getChildrenFiles('guides', 'guides.md'), - }, - ], + // '/guides/': [ + // { + // title: 'Guide Overview', + // sidebarDepth: 2, + // children: getChildrenFiles('guides', 'guides.md'), + // }, + // ], '/nodes/': [ { - title: 'Node Overview', + title: '🧬 Overview', sidebarDepth: 2, children: getChildrenFiles('nodes', 'nodes.md'), }, { - title: 'Creating Nodes', + title: '🔬 Creating Nodes', sidebarDepth: 2, children: getChildrenFiles('nodes/creating-nodes', 'create-node.md'), }, { - title: 'Nodes Library', + title: '🧠 Nodes Library', sidebarDepth: 3, children: [ { @@ -132,27 +132,87 @@ module.exports = { '/reference/': [ { - title: 'Reference Overview', - sidebarDepth: 2, - children: getChildrenFiles('reference', 'reference.md'), + title: '📚 Overview', + path: 'reference.md', }, { - title: 'Data', + title: '🧐 Changelog', + path: 'changelog.md', + }, + { + title: '🎯 Workflow', + path: 'workflow.md', + }, + { + title: '⚙️ Configuration', + path: 'configuration.md', + }, + { + title: '🚔 Security', + path: 'security.md', + }, + { + title: '📦 Docker', + path: 'docker.md', + }, + { + title: '🖥 Server Setup', + path: 'server-setup.md', + }, + { + title: '👾 Start Workflow via CLI', + path: 'start-workflows-via-cli.md', + }, + { + title: '👀 Troubleshooting', + path: 'troubleshooting.md', + }, + { + title: '💾 Data', sidebarDepth: 2, children: getChildrenFiles('reference/data'), }, + { + title: '💻 Development', + path: 'development.md', + }, + { + title: '⌨️ Keyboard Shortcuts', + path: 'keyboard-shortcuts.md', + }, + { + title: '🎫 License', + path: 'license.md', + }, + { + title: '❓ FAQ', + path: 'faq.md', + }, ], '/': [ { - title: 'Introduction', + title: '👋 Introduction', collapsable: false, path: '/', sidebarDepth: 0, }, - 'getting-started/quickstart.md', - 'getting-started/workflow.md', - 'getting-started/start-workflows-via-cli.md', + { + title: '🚀 Quickstart', + path: 'getting-started/quickstart.md', + }, + { + title: '🍄 Key Components', + path: 'getting-started/key-components.md', + }, + { + title: '💪 Creating Your First Workflow', + path: 'getting-started/creating-your-first-workflow.md', + }, + { + title: '🤔 What\'s Next?', + path: 'getting-started/whats-next.md', + }, ], // [ // { diff --git a/docs/getting-started/creating-your-first-workflow.md b/docs/getting-started/creating-your-first-workflow.md new file mode 100644 index 000000000..0fd44bf07 --- /dev/null +++ b/docs/getting-started/creating-your-first-workflow.md @@ -0,0 +1,2 @@ +# Creating Your First Workflow + diff --git a/docs/getting-started/key-components.md b/docs/getting-started/key-components.md new file mode 100644 index 000000000..9caba3a0b --- /dev/null +++ b/docs/getting-started/key-components.md @@ -0,0 +1,25 @@ +# Key Components + + +## Connection + +A connection establishes a link between nodes to route data through the workflow. Each node can have one or multiple connections. + + +## Node + +A node is an entry point for retrieving data, a function to process data or an exit for sending data. The data process includes filtering, recomposing and changing data. There can be one or several nodes for your API, service or app. You can easily connect multiple nodes, which allows you to create simple and complex workflows with them intuitively. + +For example, consider a Google Sheets node. It can be used to retrieve or write data to a Google Sheet. + + +## Trigger Node + +A trigger node is a node that starts a workflow and supplies the initial data. What triggers it, depends on the node. It could be the time, a webhook call or an event from an external service. + +For example, consider a Trello trigger node. When a Trello Board gets updated, it will trigger a workflow to start using the data from the updated board. + + +## Workflow + +A workflow is a canvas on which you can place and connect nodes. A workflow can be started manually or by trigger nodes. A workflow run ends when all active and connected nodes have processed their data. diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 179f6b7aa..814a46761 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -1 +1,75 @@ -# Quickstart \ No newline at end of file +# Quickstart + + +## Give n8n a spin + +To spin up n8n, you can run: + +```bash +npx n8n +``` + +It will download everything that is needed to start n8n. + +You can then access n8n by opening: +[http://localhost:5678](http://localhost:5678) + +## Run with docker + +To play around with n8n, you can also start it using docker: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + n8nio/n8n +``` + +Be aware that all the data will be lost once the docker container gets removed. To +persist the data mount the `~/.n8n` folder: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -v ~/.n8n:/root/.n8n \ + n8nio/n8n +``` + +More information about the Docker setup can be found in the README file of the +[Docker Image](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md). + +In case you run into issues, check out the [troubleshooting](troubleshooting.md) page or ask for help in the community [forum](https://community.n8n.io/). + +## Install with npm + +To install n8n globally: + +```bash +npm install n8n -g +``` + +### Start + +After the installation n8n can be started by simply typing in: + +```bash +n8n +# or +n8n start +``` + + +### Start with tunnel + +!> **WARNING**: This is only meant for local development and testing. It should not be used in production! + +To be able to use webhooks for trigger nodes of external services like GitHub, n8n has to be reachable from the web. To make that easy, n8n has a special tunnel service, which redirects requests from our servers to your local n8n instance (uses this code: [https://github.com/localtunnel/localtunnel](https://github.com/localtunnel/localtunnel)). + +To use it, simply start n8n with `--tunnel` + +```bash +n8n start --tunnel +``` + +In case you run into issues, check out the [troubleshooting](troubleshooting.md) page or ask for help in the community [forum](https://community.n8n.io/). diff --git a/docs/getting-started/whats-next.md b/docs/getting-started/whats-next.md new file mode 100644 index 000000000..9db2d44f6 --- /dev/null +++ b/docs/getting-started/whats-next.md @@ -0,0 +1,2 @@ +# What's Next? + diff --git a/docs/nodes/creating-nodes/create-node.md b/docs/nodes/creating-nodes/create-node.md index aa1939398..53dbc63e0 100644 --- a/docs/nodes/creating-nodes/create-node.md +++ b/docs/nodes/creating-nodes/create-node.md @@ -1,4 +1,4 @@ -# Create Node +# Creating a Node It is quite easy to create your own nodes in n8n. Mainly three things have to be defined: diff --git a/docs/nodes/nodes-library/credentials/Mandrill/README.md b/docs/nodes/nodes-library/credentials/Mandrill/README.md index 4bc791f9a..827d41a84 100644 --- a/docs/nodes/nodes-library/credentials/Mandrill/README.md +++ b/docs/nodes/nodes-library/credentials/Mandrill/README.md @@ -1 +1,3 @@ +# Mandrill + Mandrill is a Mailchimp add-on. Please refer to the [MailChimp credential docs](https://github.com/n8n-io/n8n-docs/tree/master/docs/credentials/MailChimp)! \ No newline at end of file diff --git a/docs/reference/changelog.md b/docs/reference/changelog.md new file mode 100644 index 000000000..5ddad421e --- /dev/null +++ b/docs/reference/changelog.md @@ -0,0 +1 @@ +# Changelog \ No newline at end of file diff --git a/docs/guides/development.md b/docs/reference/development.md similarity index 100% rename from docs/guides/development.md rename to docs/reference/development.md diff --git a/docs/reference/docker.md b/docs/reference/docker.md new file mode 100644 index 000000000..317b5b955 --- /dev/null +++ b/docs/reference/docker.md @@ -0,0 +1,7 @@ +# Docker + +Detailed information about how to run n8n in Docker can be found in the README +of the [Docker Image](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md). + +A basic step by step example setup of n8n with docker-compose and Let's Encrypt is available on the +[Server Setup](server-setup.md) page. diff --git a/docs/nodes/function-nodes.md b/docs/reference/function-nodes.md similarity index 100% rename from docs/nodes/function-nodes.md rename to docs/reference/function-nodes.md diff --git a/docs/getting-started/start-workflows-via-cli.md b/docs/reference/start-workflows-via-cli.md similarity index 100% rename from docs/getting-started/start-workflows-via-cli.md rename to docs/reference/start-workflows-via-cli.md diff --git a/docs/guides/troubleshooting.md b/docs/reference/troubleshooting.md similarity index 100% rename from docs/guides/troubleshooting.md rename to docs/reference/troubleshooting.md diff --git a/docs/getting-started/workflow.md b/docs/reference/workflow.md similarity index 100% rename from docs/getting-started/workflow.md rename to docs/reference/workflow.md