diff --git a/docs/reference/contributing.md b/docs/reference/contributing.md index cf4bd2f5d..bac31a76d 100644 --- a/docs/reference/contributing.md +++ b/docs/reference/contributing.md @@ -20,11 +20,35 @@ n8n users come from a wide range of backgrounds, experience levels, and interest You can participate in the [forum](https://community.n8n.io/) and help the community members out with their questions. +When sharing workflows in the community forum for debugging, use code blocks. Use triple backticks (```) to wrap the workflow JSON in a code block. + +The following video demonstrates the steps of sharing workflows on the community forum. + +
+ +
## Contribute a workflow 🧬 You can publish workflows on [n8n.io](https://n8n.io/workflows) to help other users to get started. +To share a workflow, follow these steps. + +1. Sign in to [n8n.io](https://n8n.io/login). +2. Open the [workflows](https://n8n.io/workflows) page. +3. Click on the ***+ Share New Workflow*** button. +4. Enter the name of your workflow in the ***Name*** field. The name of a workflow makes it easy for others to understand the purpose of the workflow. +5. Enter a detailed description of the workflow in the ***Description*** field. Make sure the description contains information about the nodes used in the workflow. +6. Add a screenshot of the workflow in the description. +7. In n8n, select all the nodes in your workflow (Ctrl + A) and copy them (Ctrl + C). +8. Delete the existing code in the ***Workflow Code*** field and paste your workflow in it (Ctrl + V). +9. Click on the ***Publish Workflow to Share*** button to share your workflow. + +The following video demonstrates the steps mentioned above. + +
+ +
## Contribute to the docs 📚 @@ -39,7 +63,7 @@ We have the following process for guest contributions to our [Medium publication 3. After you submit the piece, one of our team members would start a first edit (we usually do this in Google docs), where they'll try running through the article to check if everything is clear and easy to follow. 4. Once all the questions or comments are resolved, we'll do a final review before publishing the article on our Medium publication. -Depending on the length of the article and the changes that might be required, there would be a bit of a back and forth and the whole process might take somewhere between a couple of days to a week or two. +Depending on the length of the article and the changes that might be required, there would be a bit of a back and forth and the whole process might take somewhere between a couple of days to a week or two. ## Contribute to n8n 🔨 diff --git a/docs/reference/reference.md b/docs/reference/reference.md index 1d6da1750..4065624d9 100644 --- a/docs/reference/reference.md +++ b/docs/reference/reference.md @@ -11,7 +11,10 @@ Interested in learning more about n8n? You've come to the right place. - [Security](security.md) - [Docker](docker.md) - [Server Setup](server-setup.md) -- [Use n8n via CLI](start-workflows-via-cli.md) +- [CLI commands for n8n](start-workflows-via-cli.md) +- [JavaScript Code Snippets](javascript-code-snippets.md) +- [Glossary](glossary.md) +- [Function and Function Items Nodes](function-nodes.md) - [Troubleshooting](troubleshooting.md) - [Data](data/data-structure.md) - [Contributing](contributing.md) diff --git a/docs/reference/using-code-block.png b/docs/reference/using-code-block.png new file mode 100644 index 000000000..e4dc8f07d Binary files /dev/null and b/docs/reference/using-code-block.png differ