diff --git a/docs/README.md b/docs/README.md index d715c5e389..58fb7ce570 100644 --- a/docs/README.md +++ b/docs/README.md @@ -222,16 +222,6 @@ We can display a special button inviting the reader to go to a VSCode marketplac {% install-nx-console /%} ``` -#### Nx Cloud section - -We can display Nx Cloud related content in the documentation with a visual cue. - -```markdown -{% nx-cloud-section %} -Your content goes here. -{% /nx-cloud-section %} -``` - #### Side by side You can show content in a grid of 2 columns, via the `side-by-side` shortcode. diff --git a/docs/generated/manifests/cloud.json b/docs/generated/manifests/cloud.json index 6ee2df3e6a..eca8aea084 100644 --- a/docs/generated/manifests/cloud.json +++ b/docs/generated/manifests/cloud.json @@ -6,13 +6,13 @@ "file": "", "itemList": [ { - "id": "what-is-nx-cloud", - "name": "What is Nx Cloud?", + "id": "ci-with-nx", + "name": "CI with Nx", "description": "", - "file": "nx-cloud/intro/nx-cloud", + "file": "nx-cloud/intro/ci-with-nx", "itemList": [], "isExternal": false, - "path": "/nx-cloud/intro/what-is-nx-cloud", + "path": "/nx-cloud/intro/ci-with-nx", "tags": [] }, { @@ -30,14 +30,14 @@ "path": "/nx-cloud/intro", "tags": [] }, - "/nx-cloud/intro/what-is-nx-cloud": { - "id": "what-is-nx-cloud", - "name": "What is Nx Cloud?", + "/nx-cloud/intro/ci-with-nx": { + "id": "ci-with-nx", + "name": "CI with Nx", "description": "", - "file": "nx-cloud/intro/nx-cloud", + "file": "nx-cloud/intro/ci-with-nx", "itemList": [], "isExternal": false, - "path": "/nx-cloud/intro/what-is-nx-cloud", + "path": "/nx-cloud/intro/ci-with-nx", "tags": [] }, "/nx-cloud/intro/nx-cloud-workflows": { @@ -50,9 +50,395 @@ "path": "/nx-cloud/intro/nx-cloud-workflows", "tags": [] }, - "/nx-cloud/set-up": { + "/nx-cloud/recipes": { + "id": "recipes", + "name": "Recipes", + "description": "Learn how to set up Nx Cloud for your workspace.", + "file": "", + "itemList": [ + { + "id": "set-up", + "name": "Set Up CI", + "description": "Learn how to set up Nx Cloud for your workspace.", + "file": "", + "itemList": [ + { + "id": "ci-setup", + "name": "CI Setup", + "description": "", + "file": "shared/ci-overview", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/ci-setup", + "tags": ["distribute-task-execution"] + }, + { + "id": "monorepo-ci-azure", + "name": "Setting up Azure Pipelines", + "description": "", + "file": "shared/monorepo-ci-azure", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-azure", + "tags": [] + }, + { + "id": "monorepo-ci-circle-ci", + "name": "Setting up CircleCI", + "description": "", + "file": "shared/monorepo-ci-circle-ci", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-circle-ci", + "tags": [] + }, + { + "id": "monorepo-ci-github-actions", + "name": "Setting up GitHub Actions", + "description": "", + "file": "shared/monorepo-ci-github-actions", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-github-actions", + "tags": [] + }, + { + "id": "monorepo-ci-jenkins", + "name": "Setting up Jenkins", + "description": "", + "file": "shared/monorepo-ci-jenkins", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-jenkins", + "tags": [] + }, + { + "id": "monorepo-ci-gitlab", + "name": "Setting up GitLab", + "description": "", + "file": "shared/monorepo-ci-gitlab", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-gitlab", + "tags": [] + }, + { + "id": "monorepo-ci-bitbucket-pipelines", + "name": "Setting up Bitbucket", + "description": "", + "file": "shared/monorepo-ci-bitbucket-pipelines", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines", + "tags": [] + } + ], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up", + "tags": [] + }, + { + "id": "source-control-integration", + "name": "Source Control Integration", + "description": "Learn how to set up Nx Cloud for your workspace.", + "file": "", + "itemList": [ + { + "id": "github", + "name": "Enable GitHub PR Integration", + "description": "", + "file": "nx-cloud/set-up/github", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/github", + "tags": [] + }, + { + "id": "bitbucket-cloud", + "name": "Enable Bitbucket Cloud PR Integration", + "description": "", + "file": "nx-cloud/set-up/bitbucket-cloud", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/bitbucket-cloud", + "tags": [] + }, + { + "id": "gitlab", + "name": "Enable GitLab MR Integration", + "description": "", + "file": "nx-cloud/set-up/gitlab", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/gitlab", + "tags": [] + } + ], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration", + "tags": [] + }, + { + "id": "other", + "name": "Other", + "description": "Learn how to set up Nx Cloud for your workspace.", + "file": "", + "itemList": [ + { + "id": "record-commands", + "name": "Record Non-Nx Commands", + "description": "", + "file": "nx-cloud/set-up/record-commands", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/other/record-commands", + "tags": [] + }, + { + "id": "ci-deployment", + "name": "Prepare applications for deployment via CI", + "description": "", + "file": "shared/recipes/ci-deployment", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/other/ci-deployment", + "tags": ["docker", "deploy"] + } + ], + "isExternal": false, + "path": "/nx-cloud/recipes/other", + "tags": [] + } + ], + "isExternal": false, + "path": "/nx-cloud/recipes", + "tags": [] + }, + "/nx-cloud/recipes/set-up": { "id": "set-up", - "name": "Set Up", + "name": "Set Up CI", + "description": "Learn how to set up Nx Cloud for your workspace.", + "file": "", + "itemList": [ + { + "id": "ci-setup", + "name": "CI Setup", + "description": "", + "file": "shared/ci-overview", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/ci-setup", + "tags": ["distribute-task-execution"] + }, + { + "id": "monorepo-ci-azure", + "name": "Setting up Azure Pipelines", + "description": "", + "file": "shared/monorepo-ci-azure", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-azure", + "tags": [] + }, + { + "id": "monorepo-ci-circle-ci", + "name": "Setting up CircleCI", + "description": "", + "file": "shared/monorepo-ci-circle-ci", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-circle-ci", + "tags": [] + }, + { + "id": "monorepo-ci-github-actions", + "name": "Setting up GitHub Actions", + "description": "", + "file": "shared/monorepo-ci-github-actions", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-github-actions", + "tags": [] + }, + { + "id": "monorepo-ci-jenkins", + "name": "Setting up Jenkins", + "description": "", + "file": "shared/monorepo-ci-jenkins", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-jenkins", + "tags": [] + }, + { + "id": "monorepo-ci-gitlab", + "name": "Setting up GitLab", + "description": "", + "file": "shared/monorepo-ci-gitlab", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-gitlab", + "tags": [] + }, + { + "id": "monorepo-ci-bitbucket-pipelines", + "name": "Setting up Bitbucket", + "description": "", + "file": "shared/monorepo-ci-bitbucket-pipelines", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines", + "tags": [] + } + ], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up", + "tags": [] + }, + "/nx-cloud/recipes/set-up/ci-setup": { + "id": "ci-setup", + "name": "CI Setup", + "description": "", + "file": "shared/ci-overview", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/ci-setup", + "tags": ["distribute-task-execution"] + }, + "/nx-cloud/recipes/set-up/monorepo-ci-azure": { + "id": "monorepo-ci-azure", + "name": "Setting up Azure Pipelines", + "description": "", + "file": "shared/monorepo-ci-azure", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-azure", + "tags": [] + }, + "/nx-cloud/recipes/set-up/monorepo-ci-circle-ci": { + "id": "monorepo-ci-circle-ci", + "name": "Setting up CircleCI", + "description": "", + "file": "shared/monorepo-ci-circle-ci", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-circle-ci", + "tags": [] + }, + "/nx-cloud/recipes/set-up/monorepo-ci-github-actions": { + "id": "monorepo-ci-github-actions", + "name": "Setting up GitHub Actions", + "description": "", + "file": "shared/monorepo-ci-github-actions", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-github-actions", + "tags": [] + }, + "/nx-cloud/recipes/set-up/monorepo-ci-jenkins": { + "id": "monorepo-ci-jenkins", + "name": "Setting up Jenkins", + "description": "", + "file": "shared/monorepo-ci-jenkins", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-jenkins", + "tags": [] + }, + "/nx-cloud/recipes/set-up/monorepo-ci-gitlab": { + "id": "monorepo-ci-gitlab", + "name": "Setting up GitLab", + "description": "", + "file": "shared/monorepo-ci-gitlab", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-gitlab", + "tags": [] + }, + "/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines": { + "id": "monorepo-ci-bitbucket-pipelines", + "name": "Setting up Bitbucket", + "description": "", + "file": "shared/monorepo-ci-bitbucket-pipelines", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines", + "tags": [] + }, + "/nx-cloud/recipes/source-control-integration": { + "id": "source-control-integration", + "name": "Source Control Integration", + "description": "Learn how to set up Nx Cloud for your workspace.", + "file": "", + "itemList": [ + { + "id": "github", + "name": "Enable GitHub PR Integration", + "description": "", + "file": "nx-cloud/set-up/github", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/github", + "tags": [] + }, + { + "id": "bitbucket-cloud", + "name": "Enable Bitbucket Cloud PR Integration", + "description": "", + "file": "nx-cloud/set-up/bitbucket-cloud", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/bitbucket-cloud", + "tags": [] + }, + { + "id": "gitlab", + "name": "Enable GitLab MR Integration", + "description": "", + "file": "nx-cloud/set-up/gitlab", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/gitlab", + "tags": [] + } + ], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration", + "tags": [] + }, + "/nx-cloud/recipes/source-control-integration/github": { + "id": "github", + "name": "Enable GitHub PR Integration", + "description": "", + "file": "nx-cloud/set-up/github", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/github", + "tags": [] + }, + "/nx-cloud/recipes/source-control-integration/bitbucket-cloud": { + "id": "bitbucket-cloud", + "name": "Enable Bitbucket Cloud PR Integration", + "description": "", + "file": "nx-cloud/set-up/bitbucket-cloud", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/bitbucket-cloud", + "tags": [] + }, + "/nx-cloud/recipes/source-control-integration/gitlab": { + "id": "gitlab", + "name": "Enable GitLab MR Integration", + "description": "", + "file": "nx-cloud/set-up/gitlab", + "itemList": [], + "isExternal": false, + "path": "/nx-cloud/recipes/source-control-integration/gitlab", + "tags": [] + }, + "/nx-cloud/recipes/other": { + "id": "other", + "name": "Other", "description": "Learn how to set up Nx Cloud for your workspace.", "file": "", "itemList": [ @@ -63,83 +449,43 @@ "file": "nx-cloud/set-up/record-commands", "itemList": [], "isExternal": false, - "path": "/nx-cloud/set-up/record-commands", + "path": "/nx-cloud/recipes/other/record-commands", "tags": [] }, { - "id": "github", - "name": "Enable GitHub PR Integration", + "id": "ci-deployment", + "name": "Prepare applications for deployment via CI", "description": "", - "file": "nx-cloud/set-up/github", + "file": "shared/recipes/ci-deployment", "itemList": [], "isExternal": false, - "path": "/nx-cloud/set-up/github", - "tags": [] - }, - { - "id": "bitbucket-cloud", - "name": "Enable Bitbucket Cloud PR Integration", - "description": "", - "file": "nx-cloud/set-up/bitbucket-cloud", - "itemList": [], - "isExternal": false, - "path": "/nx-cloud/set-up/bitbucket-cloud", - "tags": [] - }, - { - "id": "gitlab", - "name": "Enable GitLab MR Integration", - "description": "", - "file": "nx-cloud/set-up/gitlab", - "itemList": [], - "isExternal": false, - "path": "/nx-cloud/set-up/gitlab", - "tags": [] + "path": "/nx-cloud/recipes/other/ci-deployment", + "tags": ["docker", "deploy"] } ], "isExternal": false, - "path": "/nx-cloud/set-up", + "path": "/nx-cloud/recipes/other", "tags": [] }, - "/nx-cloud/set-up/record-commands": { + "/nx-cloud/recipes/other/record-commands": { "id": "record-commands", "name": "Record Non-Nx Commands", "description": "", "file": "nx-cloud/set-up/record-commands", "itemList": [], "isExternal": false, - "path": "/nx-cloud/set-up/record-commands", + "path": "/nx-cloud/recipes/other/record-commands", "tags": [] }, - "/nx-cloud/set-up/github": { - "id": "github", - "name": "Enable GitHub PR Integration", + "/nx-cloud/recipes/other/ci-deployment": { + "id": "ci-deployment", + "name": "Prepare applications for deployment via CI", "description": "", - "file": "nx-cloud/set-up/github", + "file": "shared/recipes/ci-deployment", "itemList": [], "isExternal": false, - "path": "/nx-cloud/set-up/github", - "tags": [] - }, - "/nx-cloud/set-up/bitbucket-cloud": { - "id": "bitbucket-cloud", - "name": "Enable Bitbucket Cloud PR Integration", - "description": "", - "file": "nx-cloud/set-up/bitbucket-cloud", - "itemList": [], - "isExternal": false, - "path": "/nx-cloud/set-up/bitbucket-cloud", - "tags": [] - }, - "/nx-cloud/set-up/gitlab": { - "id": "gitlab", - "name": "Enable GitLab MR Integration", - "description": "", - "file": "nx-cloud/set-up/gitlab", - "itemList": [], - "isExternal": false, - "path": "/nx-cloud/set-up/gitlab", - "tags": [] + "path": "/nx-cloud/recipes/other/ci-deployment", + "tags": ["docker", "deploy"] }, "/nx-cloud/account": { "id": "account", @@ -254,8 +600,8 @@ }, "/nx-cloud/private-cloud": { "id": "private-cloud", - "name": "Enterprise + On Prem", - "description": "Learn about Nx Cloud Enterprise + On-Prem.", + "name": "Run Nx Cloud On-Premise", + "description": "Learn about Running Nx Cloud On-Premise", "file": "", "itemList": [ { diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index 74d89dfd7c..2f874de121 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -2068,79 +2068,6 @@ ], "disableCollapsible": false }, - { - "name": "CI", - "path": "/recipes/ci", - "id": "ci", - "isExternal": false, - "children": [ - { - "name": "CI Setup", - "path": "/recipes/ci/ci-setup", - "id": "ci-setup", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Prepare applications for deployment via CI", - "path": "/recipes/ci/ci-deployment", - "id": "ci-deployment", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Azure Pipelines", - "path": "/recipes/ci/monorepo-ci-azure", - "id": "monorepo-ci-azure", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up CircleCI", - "path": "/recipes/ci/monorepo-ci-circle-ci", - "id": "monorepo-ci-circle-ci", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up GitHub Actions", - "path": "/recipes/ci/monorepo-ci-github-actions", - "id": "monorepo-ci-github-actions", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Jenkins", - "path": "/recipes/ci/monorepo-ci-jenkins", - "id": "monorepo-ci-jenkins", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up GitLab", - "path": "/recipes/ci/monorepo-ci-gitlab", - "id": "monorepo-ci-gitlab", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Bitbucket", - "path": "/recipes/ci/monorepo-ci-bitbucket-pipelines", - "id": "monorepo-ci-bitbucket-pipelines", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, { "name": "Tips and tricks", "path": "/recipes/tips-n-tricks", @@ -3603,143 +3530,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "CI", - "path": "/recipes/ci", - "id": "ci", - "isExternal": false, - "children": [ - { - "name": "CI Setup", - "path": "/recipes/ci/ci-setup", - "id": "ci-setup", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Prepare applications for deployment via CI", - "path": "/recipes/ci/ci-deployment", - "id": "ci-deployment", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Azure Pipelines", - "path": "/recipes/ci/monorepo-ci-azure", - "id": "monorepo-ci-azure", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up CircleCI", - "path": "/recipes/ci/monorepo-ci-circle-ci", - "id": "monorepo-ci-circle-ci", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up GitHub Actions", - "path": "/recipes/ci/monorepo-ci-github-actions", - "id": "monorepo-ci-github-actions", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Jenkins", - "path": "/recipes/ci/monorepo-ci-jenkins", - "id": "monorepo-ci-jenkins", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up GitLab", - "path": "/recipes/ci/monorepo-ci-gitlab", - "id": "monorepo-ci-gitlab", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Bitbucket", - "path": "/recipes/ci/monorepo-ci-bitbucket-pipelines", - "id": "monorepo-ci-bitbucket-pipelines", - "isExternal": false, - "children": [], - "disableCollapsible": false - } - ], - "disableCollapsible": false - }, - { - "name": "CI Setup", - "path": "/recipes/ci/ci-setup", - "id": "ci-setup", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Prepare applications for deployment via CI", - "path": "/recipes/ci/ci-deployment", - "id": "ci-deployment", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Azure Pipelines", - "path": "/recipes/ci/monorepo-ci-azure", - "id": "monorepo-ci-azure", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up CircleCI", - "path": "/recipes/ci/monorepo-ci-circle-ci", - "id": "monorepo-ci-circle-ci", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up GitHub Actions", - "path": "/recipes/ci/monorepo-ci-github-actions", - "id": "monorepo-ci-github-actions", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Jenkins", - "path": "/recipes/ci/monorepo-ci-jenkins", - "id": "monorepo-ci-jenkins", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up GitLab", - "path": "/recipes/ci/monorepo-ci-gitlab", - "id": "monorepo-ci-gitlab", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, - { - "name": "Setting up Bitbucket", - "path": "/recipes/ci/monorepo-ci-bitbucket-pipelines", - "id": "monorepo-ci-bitbucket-pipelines", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Tips and tricks", "path": "/recipes/tips-n-tricks", @@ -5265,7 +5055,7 @@ "children": [ { "name": "Nx Cloud Documentation", - "path": "/nx-cloud/intro/what-is-nx-cloud", + "path": "/nx-cloud/intro/ci-with-nx", "id": "nx-cloud-documentation", "isExternal": true, "children": [], @@ -5332,7 +5122,7 @@ }, { "name": "Nx Cloud Documentation", - "path": "/nx-cloud/intro/what-is-nx-cloud", + "path": "/nx-cloud/intro/ci-with-nx", "id": "nx-cloud-documentation", "isExternal": true, "children": [], @@ -5654,9 +5444,9 @@ "isExternal": false, "children": [ { - "name": "What is Nx Cloud?", - "path": "/nx-cloud/intro/what-is-nx-cloud", - "id": "what-is-nx-cloud", + "name": "CI with Nx", + "path": "/nx-cloud/intro/ci-with-nx", + "id": "ci-with-nx", "isExternal": false, "children": [], "disableCollapsible": false @@ -5673,9 +5463,9 @@ "disableCollapsible": false }, { - "name": "What is Nx Cloud?", - "path": "/nx-cloud/intro/what-is-nx-cloud", - "id": "what-is-nx-cloud", + "name": "CI with Nx", + "path": "/nx-cloud/intro/ci-with-nx", + "id": "ci-with-nx", "isExternal": false, "children": [], "disableCollapsible": false @@ -5689,22 +5479,267 @@ "disableCollapsible": false }, { - "name": "Set Up", - "path": "/nx-cloud/set-up", + "name": "Recipes", + "path": "/nx-cloud/recipes", + "id": "recipes", + "isExternal": false, + "children": [ + { + "name": "Set Up CI", + "path": "/nx-cloud/recipes/set-up", + "id": "set-up", + "isExternal": false, + "children": [ + { + "name": "CI Setup", + "path": "/nx-cloud/recipes/set-up/ci-setup", + "id": "ci-setup", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Azure Pipelines", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-azure", + "id": "monorepo-ci-azure", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up CircleCI", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-circle-ci", + "id": "monorepo-ci-circle-ci", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up GitHub Actions", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-github-actions", + "id": "monorepo-ci-github-actions", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Jenkins", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-jenkins", + "id": "monorepo-ci-jenkins", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up GitLab", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-gitlab", + "id": "monorepo-ci-gitlab", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Bitbucket", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines", + "id": "monorepo-ci-bitbucket-pipelines", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "Source Control Integration", + "path": "/nx-cloud/recipes/source-control-integration", + "id": "source-control-integration", + "isExternal": false, + "children": [ + { + "name": "Enable GitHub PR Integration", + "path": "/nx-cloud/recipes/source-control-integration/github", + "id": "github", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Enable Bitbucket Cloud PR Integration", + "path": "/nx-cloud/recipes/source-control-integration/bitbucket-cloud", + "id": "bitbucket-cloud", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Enable GitLab MR Integration", + "path": "/nx-cloud/recipes/source-control-integration/gitlab", + "id": "gitlab", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "Other", + "path": "/nx-cloud/recipes/other", + "id": "other", + "isExternal": false, + "children": [ + { + "name": "Record Non-Nx Commands", + "path": "/nx-cloud/recipes/other/record-commands", + "id": "record-commands", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Prepare applications for deployment via CI", + "path": "/nx-cloud/recipes/other/ci-deployment", + "id": "ci-deployment", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "Set Up CI", + "path": "/nx-cloud/recipes/set-up", "id": "set-up", "isExternal": false, "children": [ { - "name": "Record Non-Nx Commands", - "path": "/nx-cloud/set-up/record-commands", - "id": "record-commands", + "name": "CI Setup", + "path": "/nx-cloud/recipes/set-up/ci-setup", + "id": "ci-setup", "isExternal": false, "children": [], "disableCollapsible": false }, + { + "name": "Setting up Azure Pipelines", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-azure", + "id": "monorepo-ci-azure", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up CircleCI", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-circle-ci", + "id": "monorepo-ci-circle-ci", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up GitHub Actions", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-github-actions", + "id": "monorepo-ci-github-actions", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Jenkins", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-jenkins", + "id": "monorepo-ci-jenkins", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up GitLab", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-gitlab", + "id": "monorepo-ci-gitlab", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Bitbucket", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines", + "id": "monorepo-ci-bitbucket-pipelines", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "CI Setup", + "path": "/nx-cloud/recipes/set-up/ci-setup", + "id": "ci-setup", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Azure Pipelines", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-azure", + "id": "monorepo-ci-azure", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up CircleCI", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-circle-ci", + "id": "monorepo-ci-circle-ci", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up GitHub Actions", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-github-actions", + "id": "monorepo-ci-github-actions", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Jenkins", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-jenkins", + "id": "monorepo-ci-jenkins", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up GitLab", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-gitlab", + "id": "monorepo-ci-gitlab", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Setting up Bitbucket", + "path": "/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines", + "id": "monorepo-ci-bitbucket-pipelines", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Source Control Integration", + "path": "/nx-cloud/recipes/source-control-integration", + "id": "source-control-integration", + "isExternal": false, + "children": [ { "name": "Enable GitHub PR Integration", - "path": "/nx-cloud/set-up/github", + "path": "/nx-cloud/recipes/source-control-integration/github", "id": "github", "isExternal": false, "children": [], @@ -5712,7 +5747,7 @@ }, { "name": "Enable Bitbucket Cloud PR Integration", - "path": "/nx-cloud/set-up/bitbucket-cloud", + "path": "/nx-cloud/recipes/source-control-integration/bitbucket-cloud", "id": "bitbucket-cloud", "isExternal": false, "children": [], @@ -5720,7 +5755,7 @@ }, { "name": "Enable GitLab MR Integration", - "path": "/nx-cloud/set-up/gitlab", + "path": "/nx-cloud/recipes/source-control-integration/gitlab", "id": "gitlab", "isExternal": false, "children": [], @@ -5729,17 +5764,9 @@ ], "disableCollapsible": false }, - { - "name": "Record Non-Nx Commands", - "path": "/nx-cloud/set-up/record-commands", - "id": "record-commands", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Enable GitHub PR Integration", - "path": "/nx-cloud/set-up/github", + "path": "/nx-cloud/recipes/source-control-integration/github", "id": "github", "isExternal": false, "children": [], @@ -5747,7 +5774,7 @@ }, { "name": "Enable Bitbucket Cloud PR Integration", - "path": "/nx-cloud/set-up/bitbucket-cloud", + "path": "/nx-cloud/recipes/source-control-integration/bitbucket-cloud", "id": "bitbucket-cloud", "isExternal": false, "children": [], @@ -5755,12 +5782,53 @@ }, { "name": "Enable GitLab MR Integration", - "path": "/nx-cloud/set-up/gitlab", + "path": "/nx-cloud/recipes/source-control-integration/gitlab", "id": "gitlab", "isExternal": false, "children": [], "disableCollapsible": false }, + { + "name": "Other", + "path": "/nx-cloud/recipes/other", + "id": "other", + "isExternal": false, + "children": [ + { + "name": "Record Non-Nx Commands", + "path": "/nx-cloud/recipes/other/record-commands", + "id": "record-commands", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Prepare applications for deployment via CI", + "path": "/nx-cloud/recipes/other/ci-deployment", + "id": "ci-deployment", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], + "disableCollapsible": false + }, + { + "name": "Record Non-Nx Commands", + "path": "/nx-cloud/recipes/other/record-commands", + "id": "record-commands", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Prepare applications for deployment via CI", + "path": "/nx-cloud/recipes/other/ci-deployment", + "id": "ci-deployment", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Account Management", "path": "/nx-cloud/account", @@ -5851,7 +5919,7 @@ "disableCollapsible": false }, { - "name": "Enterprise + On Prem", + "name": "Run Nx Cloud On-Premise", "path": "/nx-cloud/private-cloud", "id": "private-cloud", "isExternal": false, diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json index b53acd910c..0f54a3af1a 100644 --- a/docs/generated/manifests/nx.json +++ b/docs/generated/manifests/nx.json @@ -2578,97 +2578,6 @@ "path": "/recipes/enforce-module-boundaries", "tags": [] }, - { - "id": "ci", - "name": "CI", - "description": "All recipes about how to use Nx to make your CI faster.", - "file": "", - "itemList": [ - { - "id": "ci-setup", - "name": "CI Setup", - "description": "", - "file": "shared/ci-overview", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/ci-setup", - "tags": ["distribute-task-execution"] - }, - { - "id": "ci-deployment", - "name": "Prepare applications for deployment via CI", - "description": "", - "file": "shared/recipes/ci-deployment", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/ci-deployment", - "tags": ["docker", "deploy"] - }, - { - "id": "monorepo-ci-azure", - "name": "Setting up Azure Pipelines", - "description": "", - "file": "shared/monorepo-ci-azure", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-azure", - "tags": [] - }, - { - "id": "monorepo-ci-circle-ci", - "name": "Setting up CircleCI", - "description": "", - "file": "shared/monorepo-ci-circle-ci", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-circle-ci", - "tags": [] - }, - { - "id": "monorepo-ci-github-actions", - "name": "Setting up GitHub Actions", - "description": "", - "file": "shared/monorepo-ci-github-actions", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-github-actions", - "tags": [] - }, - { - "id": "monorepo-ci-jenkins", - "name": "Setting up Jenkins", - "description": "", - "file": "shared/monorepo-ci-jenkins", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-jenkins", - "tags": [] - }, - { - "id": "monorepo-ci-gitlab", - "name": "Setting up GitLab", - "description": "", - "file": "shared/monorepo-ci-gitlab", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-gitlab", - "tags": [] - }, - { - "id": "monorepo-ci-bitbucket-pipelines", - "name": "Setting up Bitbucket", - "description": "", - "file": "shared/monorepo-ci-bitbucket-pipelines", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-bitbucket-pipelines", - "tags": [] - } - ], - "isExternal": false, - "path": "/recipes/ci", - "tags": [] - }, { "id": "tips-n-tricks", "name": "Tips and tricks", @@ -4493,177 +4402,6 @@ "path": "/recipes/enforce-module-boundaries/tags-allow-list", "tags": ["enforce-module-boundaries"] }, - "/recipes/ci": { - "id": "ci", - "name": "CI", - "description": "All recipes about how to use Nx to make your CI faster.", - "file": "", - "itemList": [ - { - "id": "ci-setup", - "name": "CI Setup", - "description": "", - "file": "shared/ci-overview", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/ci-setup", - "tags": ["distribute-task-execution"] - }, - { - "id": "ci-deployment", - "name": "Prepare applications for deployment via CI", - "description": "", - "file": "shared/recipes/ci-deployment", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/ci-deployment", - "tags": ["docker", "deploy"] - }, - { - "id": "monorepo-ci-azure", - "name": "Setting up Azure Pipelines", - "description": "", - "file": "shared/monorepo-ci-azure", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-azure", - "tags": [] - }, - { - "id": "monorepo-ci-circle-ci", - "name": "Setting up CircleCI", - "description": "", - "file": "shared/monorepo-ci-circle-ci", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-circle-ci", - "tags": [] - }, - { - "id": "monorepo-ci-github-actions", - "name": "Setting up GitHub Actions", - "description": "", - "file": "shared/monorepo-ci-github-actions", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-github-actions", - "tags": [] - }, - { - "id": "monorepo-ci-jenkins", - "name": "Setting up Jenkins", - "description": "", - "file": "shared/monorepo-ci-jenkins", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-jenkins", - "tags": [] - }, - { - "id": "monorepo-ci-gitlab", - "name": "Setting up GitLab", - "description": "", - "file": "shared/monorepo-ci-gitlab", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-gitlab", - "tags": [] - }, - { - "id": "monorepo-ci-bitbucket-pipelines", - "name": "Setting up Bitbucket", - "description": "", - "file": "shared/monorepo-ci-bitbucket-pipelines", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-bitbucket-pipelines", - "tags": [] - } - ], - "isExternal": false, - "path": "/recipes/ci", - "tags": [] - }, - "/recipes/ci/ci-setup": { - "id": "ci-setup", - "name": "CI Setup", - "description": "", - "file": "shared/ci-overview", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/ci-setup", - "tags": ["distribute-task-execution"] - }, - "/recipes/ci/ci-deployment": { - "id": "ci-deployment", - "name": "Prepare applications for deployment via CI", - "description": "", - "file": "shared/recipes/ci-deployment", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/ci-deployment", - "tags": ["docker", "deploy"] - }, - "/recipes/ci/monorepo-ci-azure": { - "id": "monorepo-ci-azure", - "name": "Setting up Azure Pipelines", - "description": "", - "file": "shared/monorepo-ci-azure", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-azure", - "tags": [] - }, - "/recipes/ci/monorepo-ci-circle-ci": { - "id": "monorepo-ci-circle-ci", - "name": "Setting up CircleCI", - "description": "", - "file": "shared/monorepo-ci-circle-ci", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-circle-ci", - "tags": [] - }, - "/recipes/ci/monorepo-ci-github-actions": { - "id": "monorepo-ci-github-actions", - "name": "Setting up GitHub Actions", - "description": "", - "file": "shared/monorepo-ci-github-actions", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-github-actions", - "tags": [] - }, - "/recipes/ci/monorepo-ci-jenkins": { - "id": "monorepo-ci-jenkins", - "name": "Setting up Jenkins", - "description": "", - "file": "shared/monorepo-ci-jenkins", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-jenkins", - "tags": [] - }, - "/recipes/ci/monorepo-ci-gitlab": { - "id": "monorepo-ci-gitlab", - "name": "Setting up GitLab", - "description": "", - "file": "shared/monorepo-ci-gitlab", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-gitlab", - "tags": [] - }, - "/recipes/ci/monorepo-ci-bitbucket-pipelines": { - "id": "monorepo-ci-bitbucket-pipelines", - "name": "Setting up Bitbucket", - "description": "", - "file": "shared/monorepo-ci-bitbucket-pipelines", - "itemList": [], - "isExternal": false, - "path": "/recipes/ci/monorepo-ci-bitbucket-pipelines", - "tags": [] - }, "/recipes/tips-n-tricks": { "id": "tips-n-tricks", "name": "Tips and tricks", @@ -6570,7 +6308,7 @@ "file": "", "itemList": [], "isExternal": true, - "path": "/nx-cloud/intro/what-is-nx-cloud", + "path": "/nx-cloud/intro/ci-with-nx", "tags": ["cache-task-results", "distribute-task-execution"] }, { @@ -6648,14 +6386,14 @@ "path": "/see-also", "tags": [] }, - "/nx-cloud/intro/what-is-nx-cloud": { + "/nx-cloud/intro/ci-with-nx": { "id": "nx-cloud-documentation", "name": "Nx Cloud Documentation", "description": "", "file": "", "itemList": [], "isExternal": true, - "path": "/nx-cloud/intro/what-is-nx-cloud", + "path": "/nx-cloud/intro/ci-with-nx", "tags": ["cache-task-results", "distribute-task-execution"] }, "/nx-api/nx/documents/affected#skip-nx-cache": { diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json index 121ff37ca5..c4befd97fe 100644 --- a/docs/generated/manifests/tags.json +++ b/docs/generated/manifests/tags.json @@ -119,7 +119,7 @@ "file": "", "id": "nx-cloud-documentation", "name": "Nx Cloud Documentation", - "path": "/nx-cloud/intro/what-is-nx-cloud" + "path": "/nx-cloud/intro/ci-with-nx" }, { "description": "", @@ -195,19 +195,19 @@ "name": "Illustrated Distributed Task Execution", "path": "/concepts/more-concepts/illustrated-dte" }, - { - "description": "", - "file": "shared/ci-overview", - "id": "ci-setup", - "name": "CI Setup", - "path": "/recipes/ci/ci-setup" - }, { "description": "", "file": "", "id": "nx-cloud-documentation", "name": "Nx Cloud Documentation", - "path": "/nx-cloud/intro/what-is-nx-cloud" + "path": "/nx-cloud/intro/ci-with-nx" + }, + { + "description": "", + "file": "shared/ci-overview", + "id": "ci-setup", + "name": "CI Setup", + "path": "/nx-cloud/recipes/set-up/ci-setup" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", @@ -1051,24 +1051,6 @@ "path": "/recipes/deno/deno-netlify-functions" } ], - "docker": [ - { - "description": "", - "file": "shared/recipes/ci-deployment", - "id": "ci-deployment", - "name": "Prepare applications for deployment via CI", - "path": "/recipes/ci/ci-deployment" - } - ], - "deploy": [ - { - "description": "", - "file": "shared/recipes/ci-deployment", - "id": "ci-deployment", - "name": "Prepare applications for deployment via CI", - "path": "/recipes/ci/ci-deployment" - } - ], "yarn": [ { "description": "", @@ -1150,5 +1132,23 @@ "name": "Using PlanetScale with Serverless Fastify", "path": "/showcase/example-repos/serverless-fastify-planetscale" } + ], + "docker": [ + { + "description": "", + "file": "shared/recipes/ci-deployment", + "id": "ci-deployment", + "name": "Prepare applications for deployment via CI", + "path": "/nx-cloud/recipes/other/ci-deployment" + } + ], + "deploy": [ + { + "description": "", + "file": "shared/recipes/ci-deployment", + "id": "ci-deployment", + "name": "Prepare applications for deployment via CI", + "path": "/nx-cloud/recipes/other/ci-deployment" + } ] } diff --git a/docs/map.json b/docs/map.json index 1570fef911..a52976ae33 100644 --- a/docs/map.json +++ b/docs/map.json @@ -930,55 +930,6 @@ } ] }, - { - "name": "CI", - "id": "ci", - "description": "All recipes about how to use Nx to make your CI faster.", - "itemList": [ - { - "name": "CI Setup", - "id": "ci-setup", - "tags": ["distribute-task-execution"], - "file": "shared/ci-overview" - }, - { - "name": "Prepare applications for deployment via CI", - "id": "ci-deployment", - "tags": ["docker", "deploy"], - "file": "shared/recipes/ci-deployment" - }, - { - "name": "Setting up Azure Pipelines", - "id": "monorepo-ci-azure", - "file": "shared/monorepo-ci-azure" - }, - { - "name": "Setting up CircleCI", - "id": "monorepo-ci-circle-ci", - "file": "shared/monorepo-ci-circle-ci" - }, - { - "name": "Setting up GitHub Actions", - "id": "monorepo-ci-github-actions", - "file": "shared/monorepo-ci-github-actions" - }, - { - "name": "Setting up Jenkins", - "id": "monorepo-ci-jenkins", - "file": "shared/monorepo-ci-jenkins" - }, - { - "name": "Setting up GitLab", - "id": "monorepo-ci-gitlab", - "file": "shared/monorepo-ci-gitlab" - }, - { - "name": "Setting up Bitbucket", - "id": "monorepo-ci-bitbucket-pipelines", - "file": "shared/monorepo-ci-bitbucket-pipelines" - } - ] - }, { "name": "Tips and tricks", "id": "tips-n-tricks", @@ -1483,7 +1434,7 @@ "id": "nx-cloud-documentation", "file": "", "tags": ["cache-task-results", "distribute-task-execution"], - "path": "/nx-cloud/intro/what-is-nx-cloud", + "path": "/nx-cloud/intro/ci-with-nx", "isExternal": true }, { @@ -1665,9 +1616,9 @@ "description": "Learn about basic Nx Cloud knowledge.", "itemList": [ { - "name": "What is Nx Cloud?", - "id": "what-is-nx-cloud", - "file": "nx-cloud/intro/nx-cloud" + "name": "CI with Nx", + "id": "ci-with-nx", + "file": "nx-cloud/intro/ci-with-nx" }, { "name": "Nx Cloud Workflows", @@ -1677,29 +1628,92 @@ ] }, { - "name": "Set Up", - "id": "set-up", + "name": "Recipes", + "id": "recipes", "description": "Learn how to set up Nx Cloud for your workspace.", "itemList": [ { - "name": "Record Non-Nx Commands", - "id": "record-commands", - "file": "nx-cloud/set-up/record-commands" + "name": "Set Up CI", + "id": "set-up", + "description": "Learn how to set up Nx Cloud for your workspace.", + "itemList": [ + { + "name": "CI Setup", + "id": "ci-setup", + "tags": ["distribute-task-execution"], + "file": "shared/ci-overview" + }, + { + "name": "Setting up Azure Pipelines", + "id": "monorepo-ci-azure", + "file": "shared/monorepo-ci-azure" + }, + { + "name": "Setting up CircleCI", + "id": "monorepo-ci-circle-ci", + "file": "shared/monorepo-ci-circle-ci" + }, + { + "name": "Setting up GitHub Actions", + "id": "monorepo-ci-github-actions", + "file": "shared/monorepo-ci-github-actions" + }, + { + "name": "Setting up Jenkins", + "id": "monorepo-ci-jenkins", + "file": "shared/monorepo-ci-jenkins" + }, + { + "name": "Setting up GitLab", + "id": "monorepo-ci-gitlab", + "file": "shared/monorepo-ci-gitlab" + }, + { + "name": "Setting up Bitbucket", + "id": "monorepo-ci-bitbucket-pipelines", + "file": "shared/monorepo-ci-bitbucket-pipelines" + } + ] }, { - "name": "Enable GitHub PR Integration", - "id": "github", - "file": "nx-cloud/set-up/github" + "name": "Source Control Integration", + "id": "source-control-integration", + "description": "Learn how to set up Nx Cloud for your workspace.", + "itemList": [ + { + "name": "Enable GitHub PR Integration", + "id": "github", + "file": "nx-cloud/set-up/github" + }, + { + "name": "Enable Bitbucket Cloud PR Integration", + "id": "bitbucket-cloud", + "file": "nx-cloud/set-up/bitbucket-cloud" + }, + { + "name": "Enable GitLab MR Integration", + "id": "gitlab", + "file": "nx-cloud/set-up/gitlab" + } + ] }, { - "name": "Enable Bitbucket Cloud PR Integration", - "id": "bitbucket-cloud", - "file": "nx-cloud/set-up/bitbucket-cloud" - }, - { - "name": "Enable GitLab MR Integration", - "id": "gitlab", - "file": "nx-cloud/set-up/gitlab" + "name": "Other", + "id": "other", + "description": "Learn how to set up Nx Cloud for your workspace.", + "itemList": [ + { + "name": "Record Non-Nx Commands", + "id": "record-commands", + "file": "nx-cloud/set-up/record-commands" + }, + { + "name": "Prepare applications for deployment via CI", + "id": "ci-deployment", + "tags": ["docker", "deploy"], + "file": "shared/recipes/ci-deployment" + } + ] } ] }, @@ -1736,9 +1750,9 @@ ] }, { - "name": "Enterprise + On Prem", + "name": "Run Nx Cloud On-Premise", "id": "private-cloud", - "description": "Learn about Nx Cloud Enterprise + On-Prem.", + "description": "Learn about Running Nx Cloud On-Premise", "itemList": [ { "name": "Get Started", diff --git a/docs/nx-cloud/intro/ci-with-nx.md b/docs/nx-cloud/intro/ci-with-nx.md new file mode 100644 index 0000000000..07287993b9 --- /dev/null +++ b/docs/nx-cloud/intro/ci-with-nx.md @@ -0,0 +1,61 @@ +# Continuous Integration with Nx + +When implemented well, continuous integration (CI) allows a team of developers to efficiently make changes to a codebase with the confidence that they haven't broken existing functionality. When implemented poorly, CI slows down the team by adding obstacles to deploying code without actually providing any confidence that the code is correct. + +## Core Features + +- Test only the code that might have been [affected](/concepts/affected) by a PR +- Improve the average CI time with [remote caching](/core-features/remote-cache) +- Improve the worst case CI time with [distributed task execution](/core-features/distribute-task-execution) +- Quickly troubleshoot errors that occur in CI +- Create a simple but powerful pipeline configuration that easily scales with your codebase + +## Try Nx Cloud Yourself! + +```shell +npx nx connect +``` + +## Learn about Nx on CI + +{% cards cols="2" lgCols="6" mdCols="4" smCols="2" %} + +{% link-card title="What is Nx Cloud?" type="video" url="https://youtu.be/NZF0ZJpgaJM" icon="nxcloud" /%} + +{% link-card title="Nx Cloud 3.0 - What is new?" type="video" url="https://youtu.be/cG2hEI5L3qI?si=xVnSLMU2VN1UAEpJ" icon="nxcloud" /%} + +{% link-card title="Nx in 10 minutes!" type="video" url="https://youtu.be/-_4WMl-Fn0w" icon="nx" /%} +{% link-card title="More On Youtube" type="video" url="https://www.youtube.com/@nxdevtools" icon="youtube" /%} + +{% /cards %} + +## Ready? Get Started With Your Provider + +Run the following command + +```shell +npx nx g ci-workflow +``` + +...or choose from our guides below: + +{% cards cols="3" lgCols="8" mdCols="6" smCols="5" %} + +{% link-card title="GitHub Actions" url="/nx-cloud/recipes/set-up/monorepo-ci-github-actions" icon="github" appearance="small" /%} +{% link-card title="Circle CI" url="/nx-cloud/recipes/set-up/monorepo-ci-circle-ci" icon="circleci" appearance="small" /%} +{% link-card title="GitLab" url="/nx-cloud/recipes/set-up/monorepo-ci-gitlab" icon="gitlab" appearance="small" /%} +{% link-card title="Azure Pipelines" url="/nx-cloud/recipes/set-up/monorepo-ci-azure" icon="azure" appearance="small" /%} +{% link-card title="Bitbucket Pipelines" url="/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines" icon="bitbucket" appearance="small" /%} +{% link-card title="Jenkins" url="/nx-cloud/recipes/set-up/monorepo-ci-jenkins" icon="jenkins" appearance="small" /%} + +{% /cards %} + +## Need help? Reach out! + +Connect on our channels and with the Nx Community to ask questions, get help and keep up to date with the latest news. + +- Reach out for [Enterprise Support](https://nx.app/enterprise) +- Join our [Discord Community](https://go.nx.dev/community) +- Subscribe to our [Youtube Channel](https://www.youtube.com/@nxdevtools) +- Follow us on [Twitter](https://twitter.com/nxdevtools) +- Subscribe [to our tech newsletter](https://go.nrwl.io/nx-newsletter) diff --git a/docs/nx-cloud/intro/nx-cloud.md b/docs/nx-cloud/intro/nx-cloud.md deleted file mode 100644 index 9bed4c4f9e..0000000000 --- a/docs/nx-cloud/intro/nx-cloud.md +++ /dev/null @@ -1,35 +0,0 @@ -# What is Nx Cloud? - -{% youtube -src="https://www.youtube.com/embed/NZF0ZJpgaJM?si=1KJRAWJJmfw9c0c0" -title="What is Nx Cloud?" -width="100%" /%} - -Nx partitions a command into smaller tasks and runs them in parallel, in the correct order. Nx Cloud takes it one step further and [runs any command across multiple machines](/core-features/distribute-task-execution), while giving you a consolidated view of the command as if it ran locally. - -Nx caches the output of any previously run command such as testing and building, so it can replay the cached results instead of rerunning it. Nx Cloud allows you to [share the computation cache](/core-features/remote-cache) across everyone in your team and CI. - -And it takes five minutes to set up. - -{% personas %} -{% persona type="cache" title="Share Your Cache" url="/core-features/remote-cache" %} -Share the computation cache across CI and developer machines - -- [Set up distributed caching](/core-features/remote-cache) - -{% /persona %} - -{% persona type="distribute" title="Distribute Tasks in CI" url="/core-features/distribute-task-execution" %} - -Improve the worst case CI build by efficiently parallelizing tasks - -- [Set up distributed task execution](/core-features/distribute-task-execution) - -{% /persona %} -{% /personas %} - -## Clean User Interface - -Most developers will benefit from Nx Cloud without ever-changing any of their workflow. Commands will just execute faster. For those developers that are tasked with making the most of Nx Cloud or those that want to get more insight into the different commands executed in the repository, Nx Cloud has a clean, informative user interface. - -Take a look at the [Nx repo's Nx Cloud dashboard](https://nx.app/orgs/5e38af6de037b5000598b2d6/workspaces/5edaf12087863a0005781f17) for a real world example of how Nx Cloud is saving us CI time. diff --git a/docs/nx-cloud/private/auth-github.md b/docs/nx-cloud/private/auth-github.md index ad563fda3e..a8e4ff417c 100644 --- a/docs/nx-cloud/private/auth-github.md +++ b/docs/nx-cloud/private/auth-github.md @@ -85,5 +85,5 @@ This will point all auth endpoints to your GitHub server (rather the public one) {% callout type="check" title="Good to know!" %} The above environment variable, also helps with setting up the GitHub app integration, so you can have Nx Cloud build -stats directly on your pull request. See full set up instructions [here](/nx-cloud/set-up/github). +stats directly on your pull request. See full set up instructions [here](/nx-cloud/recipes/source-control-integration/github). {% /callout %} diff --git a/docs/nx-cloud/private/get-started.md b/docs/nx-cloud/private/get-started.md index 639a99610a..efdf58ba8d 100644 --- a/docs/nx-cloud/private/get-started.md +++ b/docs/nx-cloud/private/get-started.md @@ -57,7 +57,7 @@ We do offer, however, a multi-node Kubernetes setup, that is deployed via Helm. ## Resources -- [GitHub PR Integration](/nx-cloud/set-up/github) +- [GitHub PR Integration](/nx-cloud/recipes/source-control-integration/github) - [Auth (Basic)](/nx-cloud/private-cloud/auth-single-admin) - [GitHub Auth](/nx-cloud/private-cloud/auth-github) - [GitLab Auth](/nx-cloud/private-cloud/auth-gitlab) diff --git a/docs/nx-cloud/reference/release-notes.md b/docs/nx-cloud/reference/release-notes.md index f4e87ffe4c..946c506f36 100644 --- a/docs/nx-cloud/reference/release-notes.md +++ b/docs/nx-cloud/reference/release-notes.md @@ -66,8 +66,8 @@ When upgrading to this version and anything above it, you will need to use Helm ##### Breaking changes - MongoDB migration -In the last big release we announced [the deprecation of Mongo 4.2](https://nx.dev/nx-cloud/reference/release-notes#breaking-changes) -With this release, we have now stopped supporting Mongo 4.2 completely. Please upgrade Mongo to version 6 before installing this new image. You will find instructions [here](https://nx.dev/nx-cloud/reference/release-notes#breaking-changes). +In the last big release we announced [the deprecation of Mongo 4.2](/nx-cloud/reference/release-notes#breaking-changes) +With this release, we have now stopped supporting Mongo 4.2 completely. Please upgrade Mongo to version 6 before installing this new image. You will find instructions [here](/nx-cloud/reference/release-notes#breaking-changes). ### 2306.01.2.patch4 diff --git a/docs/shared/angular-standalone-tutorial/1-code-generation.md b/docs/shared/angular-standalone-tutorial/1-code-generation.md index 50001eea82..5c9ffd5172 100644 --- a/docs/shared/angular-standalone-tutorial/1-code-generation.md +++ b/docs/shared/angular-standalone-tutorial/1-code-generation.md @@ -41,7 +41,7 @@ Run the command `npx create-nx-workspace@latest` and when prompted, provide the ✔ Enable distributed caching to make your CI faster · Yes ``` -{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this tutorial, but you can see the introduction to Nx Cloud for more details." url="/nx-cloud/intro/what-is-nx-cloud" /%} +{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this tutorial, but you can see the introduction to Nx Cloud for more details." url="/nx-cloud/intro/ci-with-nx" /%} Once the command completes, the file structure should look like this: diff --git a/docs/shared/ci-overview.md b/docs/shared/ci-overview.md index bc8f19db93..8185ada12e 100644 --- a/docs/shared/ci-overview.md +++ b/docs/shared/ci-overview.md @@ -2,9 +2,9 @@ The following guides cover optimizing your CI/CD environments with affected commands and distributed caching: -- [Setting up CI using Azure Pipelines](/recipes/ci/monorepo-ci-azure) -- [Setting up CI using CircleCI](/recipes/ci/monorepo-ci-circle-ci) -- [Setting up CI using GitHub Actions](/recipes/ci/monorepo-ci-github-actions) -- [Setting up CI using Jenkins](/recipes/ci/monorepo-ci-jenkins) -- [Setting up CI using GitLab](/recipes/ci/monorepo-ci-gitlab) -- [Setting up CI using Bitbucket](/recipes/ci/monorepo-ci-bitbucket-pipelines) +- [Setting up CI using Azure Pipelines](/nx-cloud/recipes/set-up/monorepo-ci-azure) +- [Setting up CI using CircleCI](/nx-cloud/recipes/set-up/monorepo-ci-circle-ci) +- [Setting up CI using GitHub Actions](/nx-cloud/recipes/set-up/monorepo-ci-github-actions) +- [Setting up CI using Jenkins](/nx-cloud/recipes/set-up/monorepo-ci-jenkins) +- [Setting up CI using GitLab](/nx-cloud/recipes/set-up/monorepo-ci-gitlab) +- [Setting up CI using Bitbucket](/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines) diff --git a/docs/shared/concepts/dependency-management.md b/docs/shared/concepts/dependency-management.md index 603720c1e5..4be74ac913 100644 --- a/docs/shared/concepts/dependency-management.md +++ b/docs/shared/concepts/dependency-management.md @@ -18,4 +18,4 @@ If there are React and Angular apps in the same repo, we don't want both framewo The primary concern people have with this approach is that of coordinating updates. If two different teams are working on React apps in the same repo, they'll need to agree about when to upgrade React across the repo. This is a valid concern and beyond the scope of Nx to solve. If the developers can't cooperate, they should probably work in separate repos. On the other hand, if the teams can agree, it becomes much less work to upgrade the whole repo at the same time rather than performing that same upgrade process multiple times spread out over months or years. Performing the same code manipulation 100 places all at once is much easier than remembering how to perform that code manipulation 100 different times spread out over a year. -Consult the Nx executor's reference page to find options for populating dependencies and a lock file. If you would like to use Nx's graph to populate the dependencies of a project in your own scripts or custom executor, read about how to [prepare applications for deployment via CI](/recipes/ci/ci-deployment). +Consult the Nx executor's reference page to find options for populating dependencies and a lock file. If you would like to use Nx's graph to populate the dependencies of a project in your own scripts or custom executor, read about how to [prepare applications for deployment via CI](/nx-cloud/recipes/other/ci-deployment). diff --git a/docs/shared/core-features/distribute-task-execution.md b/docs/shared/core-features/distribute-task-execution.md index 25381a346e..ef27b07aca 100644 --- a/docs/shared/core-features/distribute-task-execution.md +++ b/docs/shared/core-features/distribute-task-execution.md @@ -150,11 +150,11 @@ CI/CD (e.g., deployment). They mainly focus on configuring Nx correctly. Read the guides for more information on how to configure them in CI. -- [Overview](/recipes/ci/ci-setup#distributed-ci-with-nx-cloud) -- [Azure Pipelines](/recipes/ci/monorepo-ci-azure#distributed-ci-with-nx-cloud) -- [Circle CI](/recipes/ci/monorepo-ci-circle-ci#distributed-ci-with-nx-cloud) -- [GitHub Actions](/recipes/ci/monorepo-ci-github-actions#distributed-ci-with-nx-cloud) -- [Jenkins](/recipes/ci/monorepo-ci-jenkins#distributed-ci-with-nx-cloud) +- [Overview](/nx-cloud/recipes/set-up/ci-setup#distributed-ci-with-nx-cloud) +- [Azure Pipelines](/nx-cloud/recipes/set-up/monorepo-ci-azure#distributed-ci-with-nx-cloud) +- [Circle CI](/nx-cloud/recipes/set-up/monorepo-ci-circle-ci#distributed-ci-with-nx-cloud) +- [GitHub Actions](/nx-cloud/recipes/set-up/monorepo-ci-github-actions#distributed-ci-with-nx-cloud) +- [Jenkins](/nx-cloud/recipes/set-up/monorepo-ci-jenkins#distributed-ci-with-nx-cloud) Note that only cacheable operations can be distributed because they have to be replayed on the main job. diff --git a/docs/shared/monorepo-ci-azure.md b/docs/shared/monorepo-ci-azure.md index 4b858217c5..97e5aeba77 100644 --- a/docs/shared/monorepo-ci-azure.md +++ b/docs/shared/monorepo-ci-azure.md @@ -148,9 +148,7 @@ jobs: - script: npx nx affected --base=$(BASE_SHA) -t build --parallel=3 ``` -{% nx-cloud-section %} - -## Distributed CI with Nx Cloud +## Distributed Task Execution with Nx Cloud Read more about [Distributed Task Execution (DTE)](/core-features/distribute-task-execution). @@ -195,5 +193,3 @@ jobs: ``` You can also use our [ci-workflow generator](/nx-api/workspace/generators/ci-workflow) to generate the pipeline file. - -{% /nx-cloud-section %} diff --git a/docs/shared/monorepo-ci-circle-ci.md b/docs/shared/monorepo-ci-circle-ci.md index 799e8218dd..a6893d5ff4 100644 --- a/docs/shared/monorepo-ci-circle-ci.md +++ b/docs/shared/monorepo-ci-circle-ci.md @@ -38,9 +38,7 @@ To use the [Nx Orb](https://github.com/nrwl/nx-orb) with a private repository on It should be a user token, not the project token. {% /callout %} -{% nx-cloud-section %} - -## Distributed CI with Nx Cloud +## Distributed Task Execution with Nx Cloud Read more about [Distributed Task Execution (DTE)](/core-features/distribute-task-execution). @@ -83,5 +81,3 @@ workflows: ``` You can also use our [ci-workflow generator](/nx-api/workspace/generators/ci-workflow) to generate the configuration file. - -{% /nx-cloud-section %} diff --git a/docs/shared/monorepo-ci-github-actions.md b/docs/shared/monorepo-ci-github-actions.md index e9135f68ac..d6374ad295 100644 --- a/docs/shared/monorepo-ci-github-actions.md +++ b/docs/shared/monorepo-ci-github-actions.md @@ -37,9 +37,7 @@ If you're using this action in the context of a branch you may need to add `run: {% /callout %} -{% nx-cloud-section %} - -## Distributed CI with Nx Cloud +## Distributed Task Execution with Nx Cloud Read more about [Distributed Task Execution (DTE)](/core-features/distribute-task-execution). @@ -193,5 +191,3 @@ jobs: env: NX_AGENT_NAME: ${{ matrix.agent }} ``` - -{% /nx-cloud-section %} diff --git a/docs/shared/monorepo-ci-gitlab.md b/docs/shared/monorepo-ci-gitlab.md index 38b25de635..5bf379862c 100644 --- a/docs/shared/monorepo-ci-gitlab.md +++ b/docs/shared/monorepo-ci-gitlab.md @@ -55,9 +55,7 @@ build: The `build` and `test` jobs implement the CI workflow using `.distributed` as a template to keep the CI configuration file more readable. -{% nx-cloud-section %} - -## Distributed CI with Nx Cloud +## Distributed Task Execution with Nx Cloud Read more about [Distributed Task Execution (DTE)](/core-features/distribute-task-execution). @@ -118,5 +116,3 @@ nx-dte-agent3: extends: .dte-agent stage: affected ``` - -{% /nx-cloud-section %} diff --git a/docs/shared/monorepo-ci-jenkins.md b/docs/shared/monorepo-ci-jenkins.md index b987140ada..4dc3c6259a 100644 --- a/docs/shared/monorepo-ci-jenkins.md +++ b/docs/shared/monorepo-ci-jenkins.md @@ -49,9 +49,7 @@ pipeline { The `pr` and `main` jobs implement the CI workflow. -{% nx-cloud-section %} - -## Distributed CI with Nx Cloud +## Distributed Task Execution with Nx Cloud Read more about [Distributed Task Execution (DTE)](/core-features/distribute-task-execution). @@ -116,5 +114,3 @@ pipeline { } } ``` - -{% /nx-cloud-section %} diff --git a/docs/shared/node-server-tutorial/1-code-generation.md b/docs/shared/node-server-tutorial/1-code-generation.md index fabeda4d85..4e37266a3c 100644 --- a/docs/shared/node-server-tutorial/1-code-generation.md +++ b/docs/shared/node-server-tutorial/1-code-generation.md @@ -47,7 +47,7 @@ Run the command `npx create-nx-workspace@latest` and when prompted, provide the ✔ Enable distributed caching to make your CI faster · Yes ``` -{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this tutorial, but you can see the introduction to Nx Cloud for more details." url="/nx-cloud/intro/what-is-nx-cloud" /%} +{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this tutorial, but you can see the introduction to Nx Cloud for more details." url="/nx-cloud/intro/ci-with-nx" /%} The `node-standalone` preset automatically creates a `products-api` application at the root of the workspace and an `e2e` project that runs against it. diff --git a/docs/shared/recipes/module-federation-with-ssr.md b/docs/shared/recipes/module-federation-with-ssr.md index 3692b1f74b..f5acca6807 100644 --- a/docs/shared/recipes/module-federation-with-ssr.md +++ b/docs/shared/recipes/module-federation-with-ssr.md @@ -18,7 +18,7 @@ Run the following command with the options listed to create an empty workspace. ✔ Enable distributed caching to make your CI faster · Yes ``` -{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this recipe, but you can see the introduction to Nx Cloud for more details." url="/nx-cloud/intro/what-is-nx-cloud" /%} +{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this recipe, but you can see the introduction to Nx Cloud for more details." url="/nx-cloud/intro/ci-with-nx" /%} ### Install your framework plugin diff --git a/docs/shared/reference/glossary.md b/docs/shared/reference/glossary.md index 9bf4a7ff6b..00d8b318d8 100644 --- a/docs/shared/reference/glossary.md +++ b/docs/shared/reference/glossary.md @@ -120,7 +120,7 @@ A [project](#project) that is located in a sub-folder of another project. This w A service that provides [distributed caching](#distributed-cache) and [distributed task execution](#distributed-task-execution). -> See: [What is Nx Cloud?](/nx-cloud/intro/what-is-nx-cloud) +> See: [CI with Nx](/nx-cloud/intro/ci-with-nx) ### Package diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index f08add4f2b..fab54358aa 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -154,15 +154,6 @@ - [Tag in Multiple Dimensions](/recipes/enforce-module-boundaries/tag-multiple-dimensions) - [Ban External Imports](/recipes/enforce-module-boundaries/ban-external-imports) - [Tags Allow List](/recipes/enforce-module-boundaries/tags-allow-list) - - [CI](/recipes/ci) - - [CI Setup](/recipes/ci/ci-setup) - - [Prepare applications for deployment via CI](/recipes/ci/ci-deployment) - - [Setting up Azure Pipelines](/recipes/ci/monorepo-ci-azure) - - [Setting up CircleCI](/recipes/ci/monorepo-ci-circle-ci) - - [Setting up GitHub Actions](/recipes/ci/monorepo-ci-github-actions) - - [Setting up Jenkins](/recipes/ci/monorepo-ci-jenkins) - - [Setting up GitLab](/recipes/ci/monorepo-ci-gitlab) - - [Setting up Bitbucket](/recipes/ci/monorepo-ci-bitbucket-pipelines) - [Tips and tricks](/recipes/tips-n-tricks) - [Add a Package-based Project in an Integrated Repo](/recipes/tips-n-tricks/package-based-in-integrated) - [Add an Integrated Project in a Package-based Repo](/recipes/tips-n-tricks/integrated-in-package-based) @@ -272,20 +263,31 @@ - Cloud - [Intro](/nx-cloud/intro) - - [What is Nx Cloud?](/nx-cloud/intro/what-is-nx-cloud) + - [CI with Nx](/nx-cloud/intro/ci-with-nx) - [Nx Cloud Workflows](/nx-cloud/intro/nx-cloud-workflows) - - [Set Up](/nx-cloud/set-up) - - [Record Non-Nx Commands](/nx-cloud/set-up/record-commands) - - [Enable GitHub PR Integration](/nx-cloud/set-up/github) - - [Enable Bitbucket Cloud PR Integration](/nx-cloud/set-up/bitbucket-cloud) - - [Enable GitLab MR Integration](/nx-cloud/set-up/gitlab) + - [Recipes](/nx-cloud/recipes) + - [Set Up CI](/nx-cloud/recipes/set-up) + - [CI Setup](/nx-cloud/recipes/set-up/ci-setup) + - [Setting up Azure Pipelines](/nx-cloud/recipes/set-up/monorepo-ci-azure) + - [Setting up CircleCI](/nx-cloud/recipes/set-up/monorepo-ci-circle-ci) + - [Setting up GitHub Actions](/nx-cloud/recipes/set-up/monorepo-ci-github-actions) + - [Setting up Jenkins](/nx-cloud/recipes/set-up/monorepo-ci-jenkins) + - [Setting up GitLab](/nx-cloud/recipes/set-up/monorepo-ci-gitlab) + - [Setting up Bitbucket](/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines) + - [Source Control Integration](/nx-cloud/recipes/source-control-integration) + - [Enable GitHub PR Integration](/nx-cloud/recipes/source-control-integration/github) + - [Enable Bitbucket Cloud PR Integration](/nx-cloud/recipes/source-control-integration/bitbucket-cloud) + - [Enable GitLab MR Integration](/nx-cloud/recipes/source-control-integration/gitlab) + - [Other](/nx-cloud/recipes/other) + - [Record Non-Nx Commands](/nx-cloud/recipes/other/record-commands) + - [Prepare applications for deployment via CI](/nx-cloud/recipes/other/ci-deployment) - [Account Management](/nx-cloud/account) - [Users](/nx-cloud/account/users) - [Authenticate with Google Identity](/nx-cloud/account/google-auth) - [Access Tokens](/nx-cloud/account/access-tokens) - [Security Scenarios](/nx-cloud/account/scenarios) - [End to End Encryption](/nx-cloud/account/encryption) - - [Enterprise + On Prem](/nx-cloud/private-cloud) + - [Run Nx Cloud On-Premise](/nx-cloud/private-cloud) - [Get Started](/nx-cloud/private-cloud/get-started) - [Authenticate with a Single Admin](/nx-cloud/private-cloud/auth-single-admin) - [Authenticate with GitHub](/nx-cloud/private-cloud/auth-github) diff --git a/nx-dev/data-access-menu/src/lib/menu.utils.ts b/nx-dev/data-access-menu/src/lib/menu.utils.ts index c4114220d7..8cd4313bce 100644 --- a/nx-dev/data-access-menu/src/lib/menu.utils.ts +++ b/nx-dev/data-access-menu/src/lib/menu.utils.ts @@ -79,7 +79,12 @@ export function getBasicNxCloudSection(items: MenuItem[]): MenuSection { hideSectionHeader: true, itemList: items .filter( - (m) => m.id === 'intro' || m.id === 'set-up' || m.id === 'account' + (m) => + m.id === 'intro' || + m.id === 'recipes' || + m.id === 'account' || + m.id === 'private-cloud' || + m.id === 'reference' ) .map((m) => { return { @@ -96,7 +101,7 @@ export function getDeepDiveNxCloudSection(items: MenuItem[]): MenuSection { name: 'Deep Dive', hideSectionHeader: false, itemList: items - .filter((m) => m.id === 'private-cloud' || m.id === 'reference') + .filter((m) => m.id === 'private-cloud') .map((m) => ({ ...m, disableCollapsible: true, diff --git a/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx b/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx index c15d487170..c0ff8d9354 100644 --- a/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx +++ b/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx @@ -24,6 +24,7 @@ export function DocViewer({ const router = useRouter(); const hideTableOfContent = router.asPath.includes('/getting-started/intro') || + router.asPath.includes('/nx-cloud/intro/ci-with-nx') || router.asPath.includes('/extending-nx/intro/getting-started') || router.asPath.includes('/nx-api/devkit') || router.asPath.includes('/reference/glossary'); diff --git a/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts b/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts index 76041fc88d..a3628e7fdb 100644 --- a/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts +++ b/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts @@ -2,14 +2,17 @@ import { assertTextOnPage } from './helpers'; import { test, expect } from '@playwright/test'; const pages: Array<{ title: string; path: string }> = [ - { title: 'What is Nx Cloud?', path: '/nx-cloud/intro/what-is-nx-cloud' }, + { + title: 'Continuous Integration with Nx', + path: '/nx-cloud/intro/ci-with-nx', + }, { title: 'Recording Non-Nx Commands', - path: '/nx-cloud/set-up/record-commands', + path: '/nx-cloud/recipes/other/record-commands', }, { title: 'Enable GitHub PR Integration', - path: '/nx-cloud/set-up/github', + path: '/nx-cloud/recipes/source-control-integration/github', }, { title: 'User Management', diff --git a/nx-dev/nx-dev/pages/nx-cloud/[...segments].tsx b/nx-dev/nx-dev/pages/nx-cloud/[...segments].tsx index b4d9791d0a..8e8c5c11f4 100644 --- a/nx-dev/nx-dev/pages/nx-cloud/[...segments].tsx +++ b/nx-dev/nx-dev/pages/nx-cloud/[...segments].tsx @@ -1,7 +1,4 @@ -import { - getBasicNxCloudSection, - getDeepDiveNxCloudSection, -} from '@nx/nx-dev/data-access-menu'; +import { getBasicNxCloudSection } from '@nx/nx-dev/data-access-menu'; import { DocViewer } from '@nx/nx-dev/feature-doc-viewer'; import { ProcessedDocument, RelatedDocument } from '@nx/nx-dev/models-document'; import { Menu, MenuItem } from '@nx/nx-dev/models-menu'; @@ -53,7 +50,7 @@ export default function Pages({ } = { document, menu: { - sections: [getBasicNxCloudSection(menu), getDeepDiveNxCloudSection(menu)], + sections: [getBasicNxCloudSection(menu)], }, relatedDocuments, }; diff --git a/nx-dev/nx-dev/pages/nx-cloud/index.tsx b/nx-dev/nx-dev/pages/nx-cloud/index.tsx index e2af93431a..c2da92c470 100644 --- a/nx-dev/nx-dev/pages/nx-cloud/index.tsx +++ b/nx-dev/nx-dev/pages/nx-cloud/index.tsx @@ -1,7 +1,4 @@ -import { - getBasicNxCloudSection, - getDeepDiveNxCloudSection, -} from '@nx/nx-dev/data-access-menu'; +import { getBasicNxCloudSection } from '@nx/nx-dev/data-access-menu'; import { DocViewer } from '@nx/nx-dev/feature-doc-viewer'; import { ProcessedDocument, RelatedDocument } from '@nx/nx-dev/models-document'; import { Menu, MenuItem } from '@nx/nx-dev/models-menu'; @@ -53,7 +50,7 @@ export default function CloudRoot({ } = { document, menu: { - sections: [getBasicNxCloudSection(menu), getDeepDiveNxCloudSection(menu)], + sections: [getBasicNxCloudSection(menu)], }, relatedDocuments, }; diff --git a/nx-dev/nx-dev/redirect-rules.js b/nx-dev/nx-dev/redirect-rules.js index faf03696b6..71f9561b67 100644 --- a/nx-dev/nx-dev/redirect-rules.js +++ b/nx-dev/nx-dev/redirect-rules.js @@ -394,6 +394,30 @@ const nxCloudUrls = { '/nx-cloud/private-cloud/standalone': '/nx-cloud/private-cloud/ami-setup', '/nx-cloud/private-cloud/kubernetes-setup': '/nx-cloud/private-cloud/get-started', + '/recipes/ci': '/nx-cloud/recipes', + '/recipes/ci/ci-setup': '/nx-cloud/recipes/set-up/ci-setup', + '/recipes/ci/monorepo-ci-azure': '/nx-cloud/recipes/set-up/monorepo-ci-azure', + '/recipes/ci/monorepo-ci-circle-ci': + '/nx-cloud/recipes/set-up/monorepo-ci-circle-ci', + '/recipes/ci/monorepo-ci-github-action': + '/nx-cloud/recipes/set-up/monorepo-ci-github-action', + '/recipes/ci/monorepo-ci-jenkins': + '/nx-cloud/recipes/set-up/monorepo-ci-jenkins', + '/recipes/ci/monorepo-ci-gitlab': + '/nx-cloud/recipes/set-up/monorepo-ci-gitlab', + '/recipes/ci/monorepo-ci-bitbucket-pipelines': + '/nx-cloud/recipes/set-up/monorepo-ci-bitbucket-pipelines', + '/recipes/ci/ci-deployment': '/nx-cloud/recipes/other/ci-deployment', + '/nx-cloud/intro/what-is-nx-cloud': '/nx-cloud/intro/ci-with-nx', + '/nx-cloud/intro/nx-cloud-workflows': '/nx-cloud/intro/nx-cloud-workflows', + '/nx-cloud/set-up': '/nx-cloud/recipes/set-up', + '/nx-cloud/set-up/record-commands': '/nx-cloud/recipes/other/record-commands', + '/nx-cloud/set-up/github': + '/nx-cloud/recipes/source-control-integration/github', + '/nx-cloud/set-up/bitbucket-cloud': + '/nx-cloud/recipes/source-control-integration/bitbucket-cloud', + '/nx-cloud/set-up/gitlab': + '/nx-cloud/recipes/source-control-integration/gitlab', }; /** diff --git a/nx-dev/ui-common/src/lib/documentation-header.tsx b/nx-dev/ui-common/src/lib/documentation-header.tsx index f8697774d9..8f7612e6c6 100644 --- a/nx-dev/ui-common/src/lib/documentation-header.tsx +++ b/nx-dev/ui-common/src/lib/documentation-header.tsx @@ -58,7 +58,7 @@ export function DocumentationHeader({ { name: 'Nx', href: '/getting-started/intro', current: isNx }, { name: 'Nx Cloud', - href: '/nx-cloud/intro/what-is-nx-cloud', + href: '/nx-cloud/intro/ci-with-nx', current: isNxCloud, }, { diff --git a/nx-dev/ui-common/src/lib/header.tsx b/nx-dev/ui-common/src/lib/header.tsx index ad6e24a5f4..cc84d5531f 100644 --- a/nx-dev/ui-common/src/lib/header.tsx +++ b/nx-dev/ui-common/src/lib/header.tsx @@ -52,7 +52,7 @@ export function Header(): JSX.Element { name: 'Nx Cloud', description: 'Learn everything about remote cache and distributed tasks configuration.', - href: '/nx-cloud/intro/what-is-nx-cloud', + href: '/nx-cloud/intro/ci-with-nx', }, ]; const flyoutMobileMenu = [ diff --git a/nx-dev/ui-common/src/lib/sidebar.tsx b/nx-dev/ui-common/src/lib/sidebar.tsx index 68bfcfb9a6..0acf368d40 100644 --- a/nx-dev/ui-common/src/lib/sidebar.tsx +++ b/nx-dev/ui-common/src/lib/sidebar.tsx @@ -187,7 +187,7 @@ export function SidebarMobile({ { name: 'Nx', href: '/getting-started/intro', current: isNx }, { name: 'Nx Cloud', - href: '/nx-cloud/intro/what-is-nx-cloud', + href: '/nx-cloud/intro/ci-with-nx', current: isNxCloud, }, { diff --git a/nx-dev/ui-markdoc/src/index.ts b/nx-dev/ui-markdoc/src/index.ts index 69acf32056..09ce5368d8 100644 --- a/nx-dev/ui-markdoc/src/index.ts +++ b/nx-dev/ui-markdoc/src/index.ts @@ -29,8 +29,6 @@ import { Iframe } from './lib/tags/iframe.component'; import { iframe } from './lib/tags/iframe.schema'; import { InstallNxConsole } from './lib/tags/install-nx-console.component'; import { installNxConsole } from './lib/tags/install-nx-console.schema'; -import { NxCloudSection } from './lib/tags/nx-cloud-section.component'; -import { nxCloudSection } from './lib/tags/nx-cloud-section.schema'; import { Persona, Personas } from './lib/tags/personas.component'; import { persona, personas } from './lib/tags/personas.schema'; import { SideBySide } from './lib/tags/side-by-side.component'; @@ -70,7 +68,6 @@ export const getMarkdocCustomConfig = ( graph, iframe, 'install-nx-console': installNxConsole, - 'nx-cloud-section': nxCloudSection, persona, personas, pill, @@ -96,7 +93,6 @@ export const getMarkdocCustomConfig = ( Heading, Iframe, InstallNxConsole, - NxCloudSection, Persona, Personas, Pill, diff --git a/nx-dev/ui-markdoc/src/lib/icons.tsx b/nx-dev/ui-markdoc/src/lib/icons.tsx index ca3dc6ac14..086e1f5c7c 100644 --- a/nx-dev/ui-markdoc/src/lib/icons.tsx +++ b/nx-dev/ui-markdoc/src/lib/icons.tsx @@ -177,7 +177,6 @@ export const frameworkIcons: Record< @@ -1035,4 +1034,413 @@ export const frameworkIcons: Record< ), }, + azure: { + image: ( + + Azure Pipelines + + + + + + + + + ), + }, + bitbucket: { + image: ( + + + + + + + + Bitbucket + + + + + + + + ), + }, + circleci: { + image: ( + + Circle CI + + + + ), + }, + github: { + image: ( + + GitHub + + + ), + }, + gitlab: { + image: ( + + GitLab + + + + + + + + ), + }, + jenkins: { + image: ( + + jenkins-logo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ), + }, }; diff --git a/nx-dev/ui-markdoc/src/lib/tags/nx-cloud-section.component.tsx b/nx-dev/ui-markdoc/src/lib/tags/nx-cloud-section.component.tsx deleted file mode 100644 index b8808318f4..0000000000 --- a/nx-dev/ui-markdoc/src/lib/tags/nx-cloud-section.component.tsx +++ /dev/null @@ -1,44 +0,0 @@ -import { ReactNode } from 'react'; - -export function NxCloudSection({ children }: { children: ReactNode }) { - return ( -
- - - {children} -
- ); -} diff --git a/nx-dev/ui-markdoc/src/lib/tags/nx-cloud-section.schema.ts b/nx-dev/ui-markdoc/src/lib/tags/nx-cloud-section.schema.ts deleted file mode 100644 index df0e44318f..0000000000 --- a/nx-dev/ui-markdoc/src/lib/tags/nx-cloud-section.schema.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { Schema } from '@markdoc/markdoc'; - -export const nxCloudSection: Schema = { - render: 'NxCloudSection', - attributes: {}, -};