diff --git a/docs/_images/environments/pull-icon.png b/docs/_images/source-control/pull-icon.png similarity index 100% rename from docs/_images/environments/pull-icon.png rename to docs/_images/source-control/pull-icon.png diff --git a/docs/_images/environments/pull-push-menu-closed.png b/docs/_images/source-control/pull-push-menu-closed.png similarity index 100% rename from docs/_images/environments/pull-push-menu-closed.png rename to docs/_images/source-control/pull-push-menu-closed.png diff --git a/docs/_images/environments/pull-push-menu-open.png b/docs/_images/source-control/pull-push-menu-open.png similarity index 100% rename from docs/_images/environments/pull-push-menu-open.png rename to docs/_images/source-control/pull-push-menu-open.png diff --git a/docs/_images/environments/push-icon.png b/docs/_images/source-control/push-icon.png similarity index 100% rename from docs/_images/environments/push-icon.png rename to docs/_images/source-control/push-icon.png diff --git a/docs/_images/environments/simple-git-branch.png b/docs/_images/source-control/simple-git-branch.png similarity index 100% rename from docs/_images/environments/simple-git-branch.png rename to docs/_images/source-control/simple-git-branch.png diff --git a/docs/_images/environments/variables-created.png b/docs/_images/source-control/variables-created.png similarity index 100% rename from docs/_images/environments/variables-created.png rename to docs/_images/source-control/variables-created.png diff --git a/docs/_images/environments/vc-multi-multi.png b/docs/_images/source-control/vc-multi-multi.png similarity index 100% rename from docs/_images/environments/vc-multi-multi.png rename to docs/_images/source-control/vc-multi-multi.png diff --git a/docs/_images/environments/vc-multi-one.png b/docs/_images/source-control/vc-multi-one.png similarity index 100% rename from docs/_images/environments/vc-multi-one.png rename to docs/_images/source-control/vc-multi-one.png diff --git a/docs/_images/environments/vc-one-multi.png b/docs/_images/source-control/vc-one-multi.png similarity index 100% rename from docs/_images/environments/vc-one-multi.png rename to docs/_images/source-control/vc-one-multi.png diff --git a/docs/_images/environments/vc-one-one.png b/docs/_images/source-control/vc-one-one.png similarity index 100% rename from docs/_images/environments/vc-one-one.png rename to docs/_images/source-control/vc-one-one.png diff --git a/docs/_redirects b/docs/_redirects index 7517c8212..e05040304 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,3 +1,5 @@ +/environments/variables/ /variables/ + /hosting/logging/ /hosting/logging-monitoring/logging/ /code-examples/console-log/ /code-examples/javascript-functions/console-log/ diff --git a/docs/environments/create/create-environments.md b/docs/environments/create-environments.md similarity index 100% rename from docs/environments/create/create-environments.md rename to docs/environments/create-environments.md diff --git a/docs/environments/create/index.md b/docs/environments/create/index.md deleted file mode 100644 index 54c1da01a..000000000 --- a/docs/environments/create/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Creat environments -description: Create environments in n8n using the source control feature. ---- - -# Create environments - -n8n supports Git-based source control to support environments. Linking your n8n instances to a Git repository allows you to create multiple n8n environments, backed by Git branches. - -Each environment has its own version of your workflows, tags, and variables. - -[TODO] diff --git a/docs/environments/index-old.md b/docs/environments/index-old.md new file mode 100644 index 000000000..6899c69bb --- /dev/null +++ b/docs/environments/index-old.md @@ -0,0 +1,21 @@ +--- +description: Environments offer users a way to safely develop and test workflows, without impacting production workflows. +--- + +# Environments + +!!! info "Feature availability: Variables" + * Available on Self-hosted Enterprise and Pro Cloud plans. + * You need access to the n8n instance owner account to create and edit variables. + +!!! info "Feature availability: Version control" + * Available on Self-hosted Enterprise. + * You need access to the n8n instance owner account to set up version control. + +Environments allow you to: + +* Share reusable values between users with [Variables](/environments/variables/). +* Develop and test workflows, without impacting production workflows, using [Version control](/environments/version-control/). + + +This feature is under development. As of version 0.225.0, n8n supports [Variables](/environments/variables/). diff --git a/docs/environments/index.md b/docs/environments/index.md index 6899c69bb..54c1da01a 100644 --- a/docs/environments/index.md +++ b/docs/environments/index.md @@ -1,21 +1,12 @@ --- -description: Environments offer users a way to safely develop and test workflows, without impacting production workflows. +title: Creat environments +description: Create environments in n8n using the source control feature. --- -# Environments +# Create environments -!!! info "Feature availability: Variables" - * Available on Self-hosted Enterprise and Pro Cloud plans. - * You need access to the n8n instance owner account to create and edit variables. +n8n supports Git-based source control to support environments. Linking your n8n instances to a Git repository allows you to create multiple n8n environments, backed by Git branches. -!!! info "Feature availability: Version control" - * Available on Self-hosted Enterprise. - * You need access to the n8n instance owner account to set up version control. +Each environment has its own version of your workflows, tags, and variables. -Environments allow you to: - -* Share reusable values between users with [Variables](/environments/variables/). -* Develop and test workflows, without impacting production workflows, using [Version control](/environments/version-control/). - - -This feature is under development. As of version 0.225.0, n8n supports [Variables](/environments/variables/). +[TODO] diff --git a/docs/environments/create/understand.md b/docs/environments/understand.md similarity index 100% rename from docs/environments/create/understand.md rename to docs/environments/understand.md diff --git a/docs/environments/source-control/index.md b/docs/source-control/index.md similarity index 100% rename from docs/environments/source-control/index.md rename to docs/source-control/index.md diff --git a/docs/environments/source-control/setup.md b/docs/source-control/setup.md similarity index 100% rename from docs/environments/source-control/setup.md rename to docs/source-control/setup.md diff --git a/docs/environments/source-control/understand.md b/docs/source-control/understand.md similarity index 95% rename from docs/environments/source-control/understand.md rename to docs/source-control/understand.md index 3aa4b1e4a..a49e7ec53 100644 --- a/docs/environments/source-control/understand.md +++ b/docs/source-control/understand.md @@ -26,7 +26,7 @@ This is the setup to use if you want different n8n instances for testing and pro [TODO: note that this is one possible multi-env setup, and main advantage is PR and safety] -![Diagram](/_images/environments/vc-multi-multi.png) +![Diagram](/_images/source-control/vc-multi-multi.png) ### Multiple instances, one branch @@ -36,7 +36,7 @@ Use this pattern if you want the same workflows, tags, and variables everywhere, This is useful when testing a new version of n8n: you can create a new n8n instance with the new version, connect it to the Git branch and test it, while your production instance remains on the older version until you're confident it's safe to upgrade. -![Diagram](/_images/environments/vc-multi-one.png) +![Diagram](/_images/source-control/vc-multi-one.png) ### One instance, multiple branches @@ -44,13 +44,13 @@ The instance owner can change which Git branch connects to the instance. The ful This is useful to review work. For example, different users could work on their own instance and push to their own branch. The reviewer could work in a review instance, and switch between branches to load work from different users. In this case, -![Diagram](/_images/environments/vc-one-multi.png) +![Diagram](/_images/source-control/vc-one-multi.png) ### One instance, one branch This is the simplest pattern. -![Diagram](/_images/environments/vc-one-one.png) +![Diagram](/_images/source-control/vc-one-one.png) ## Git: Key terms and concepts @@ -67,7 +67,7 @@ This section provides the concepts and terminology needed to save work to Git fr Git uses branches to maintain multiple copies of a document alongside each other. Every branch has its own version. A common pattern is to have a main branch, and then everyone who wants to contribute to the project works on their own branch (copy). When their work is finished, their branch is merged back into the main branch. -![Diagram](/_images/environments/simple-git-branch.png) +![Diagram](/_images/source-control/simple-git-branch.png) ### Local and remote: Moving work between your machine and a Git provider diff --git a/docs/environments/source-control/using.md b/docs/source-control/using.md similarity index 96% rename from docs/environments/source-control/using.md rename to docs/source-control/using.md index 11406f053..b205d47c4 100644 --- a/docs/environments/source-control/using.md +++ b/docs/source-control/using.md @@ -18,7 +18,7 @@ Refer to [Understand environments and version control in n8n](/environments/vers ## Fetch other people's work -To pull work from Git, select **Pull** ![Pull icon](/_images/environments/pull-icon.png) in the main menu. +To pull work from Git, select **Pull** ![Pull icon](/_images/source-control/pull-icon.png) in the main menu. --8<-- "_snippets/environments/push-pull-menu-state.md" @@ -36,7 +36,7 @@ Select **Pull and override** if you want to override your local work with the co To push work to Git: -1. Select **Push** ![Push icon](/_images/environments/push-icon.png) in the main menu. +1. Select **Push** ![Push icon](/_images/source-control/push-icon.png) in the main menu. --8<-- "_snippets/environments/push-pull-menu-state.md" diff --git a/docs/environments/variables.md b/docs/variables.md similarity index 100% rename from docs/environments/variables.md rename to docs/variables.md diff --git a/mkdocs.yml b/mkdocs.yml index f93c44a1a..80d7f961b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -208,18 +208,16 @@ nav: - Okta Workforce Identity SAML setup: user-management/saml/okta.md - Troubleshooting: user-management/saml/troubleshooting.md - Manage users with SAML: user-management/saml/managing.md - - Environments: + - Create environments with source control: - environments/index.md - - Create environments with source control: - - environments/create/index.md - - Understand: environments/create/understand.md - - "Tutorial: Create environments with source control": environments/create/create-environments.md - - Source control: - - environments/source-control/index.md - - Understand: environments/source-control/understand.md - - Set up: environments/source-control/setup.md - - Use: environments/source-control/using.md - - Variables: environments/variables.md + - Understand: environments/understand.md + - "Tutorial: Create environments with source control": environments/create-environments.md + - Source control: + - /source-control/index.md + - Understand: /source-control/understand.md + - Set up: /source-control/setup.md + - Use: /source-control/using.md + - Variables: /variables.md - Log streaming: log-streaming.md - Privacy and security: - privacy-security/index.md