docs(core): sync top menu features with sidebar (#26814)

- Syncs top menu features drop down names with sidebar - Moves Setup enterprise feature under Enterprise -> On Premise - Collapse concepts section in CI tab
2024-07-03 14:04:58 -04:00 · 2024-07-03 14:04:58 -04:00 · 7cd35e0ca1
commit 7cd35e0ca1
parent fa3c5c42cd
10 changed files with 112 additions and 134 deletions
--- a/docs/generated/manifests/ci.json
+++ b/docs/generated/manifests/ci.json
@ -217,17 +217,6 @@
        "isExternal": false,
        "path": "/ci/features/flaky-tasks",
        "tags": []
-      },
-      {
-        "id": "on-premise",
-        "name": "Set up Nx Cloud On-Premise",
-        "description": "Set up Nx Cloud on machines that you control",
-        "mediaImage": "",
-        "file": "nx-cloud/features/nx-enterprise-on-prem",
-        "itemList": [],
-        "isExternal": false,
-        "path": "/ci/features/on-premise",
-        "tags": ["on-premise"]
      }
    ],
    "isExternal": false,
@ -300,17 +289,6 @@
    "path": "/ci/features/flaky-tasks",
    "tags": []
  },
-  "/ci/features/on-premise": {
-    "id": "on-premise",
-    "name": "Set up Nx Cloud On-Premise",
-    "description": "Set up Nx Cloud on machines that you control",
-    "mediaImage": "",
-    "file": "nx-cloud/features/nx-enterprise-on-prem",
-    "itemList": [],
-    "isExternal": false,
-    "path": "/ci/features/on-premise",
-    "tags": ["on-premise"]
-  },
  "/ci/concepts": {
    "id": "concepts",
    "name": "Concepts",
@ -622,6 +600,17 @@
            "mediaImage": "",
            "file": "",
            "itemList": [
+              {
+                "id": "on-premise",
+                "name": "Set up Nx Cloud On-Premise",
+                "description": "Set up Nx Cloud on machines that you control",
+                "mediaImage": "",
+                "file": "nx-cloud/features/nx-enterprise-on-prem",
+                "itemList": [],
+                "isExternal": false,
+                "path": "/ci/recipes/enterprise/on-premise/on-premise",
+                "tags": ["on-premise"]
+              },
              {
                "id": "auth-single-admin",
                "name": "Authenticate with a Single Admin",
@ -1206,6 +1195,17 @@
        "mediaImage": "",
        "file": "",
        "itemList": [
+          {
+            "id": "on-premise",
+            "name": "Set up Nx Cloud On-Premise",
+            "description": "Set up Nx Cloud on machines that you control",
+            "mediaImage": "",
+            "file": "nx-cloud/features/nx-enterprise-on-prem",
+            "itemList": [],
+            "isExternal": false,
+            "path": "/ci/recipes/enterprise/on-premise/on-premise",
+            "tags": ["on-premise"]
+          },
          {
            "id": "auth-single-admin",
            "name": "Authenticate with a Single Admin",
@ -1400,6 +1400,17 @@
    "mediaImage": "",
    "file": "",
    "itemList": [
+      {
+        "id": "on-premise",
+        "name": "Set up Nx Cloud On-Premise",
+        "description": "Set up Nx Cloud on machines that you control",
+        "mediaImage": "",
+        "file": "nx-cloud/features/nx-enterprise-on-prem",
+        "itemList": [],
+        "isExternal": false,
+        "path": "/ci/recipes/enterprise/on-premise/on-premise",
+        "tags": ["on-premise"]
+      },
      {
        "id": "auth-single-admin",
        "name": "Authenticate with a Single Admin",
@ -1504,6 +1515,17 @@
    "path": "/ci/recipes/enterprise/on-premise",
    "tags": []
  },
+  "/ci/recipes/enterprise/on-premise/on-premise": {
+    "id": "on-premise",
+    "name": "Set up Nx Cloud On-Premise",
+    "description": "Set up Nx Cloud on machines that you control",
+    "mediaImage": "",
+    "file": "nx-cloud/features/nx-enterprise-on-prem",
+    "itemList": [],
+    "isExternal": false,
+    "path": "/ci/recipes/enterprise/on-premise/on-premise",
+    "tags": ["on-premise"]
+  },
  "/ci/recipes/enterprise/on-premise/auth-single-admin": {
    "id": "auth-single-admin",
    "name": "Authenticate with a Single Admin",
--- a/docs/generated/manifests/menus.json
+++ b/docs/generated/manifests/menus.json
@ -284,7 +284,7 @@
            "disableCollapsible": false
          },
          {
-            "name": "Explore your Workspace",
+            "name": "Explore Your Workspace",
            "path": "/features/explore-graph",
            "id": "explore-graph",
            "isExternal": false,
@ -376,14 +376,6 @@
                "isExternal": true,
                "children": [],
                "disableCollapsible": false
-              },
-              {
-                "name": "Set up Nx Cloud On-Premise",
-                "path": "/ci/features/on-premise",
-                "id": "on-premise",
-                "isExternal": true,
-                "children": [],
-                "disableCollapsible": false
              }
            ],
            "disableCollapsible": false
@ -408,7 +400,7 @@
        "disableCollapsible": false
      },
      {
-        "name": "Explore your Workspace",
+        "name": "Explore Your Workspace",
        "path": "/features/explore-graph",
        "id": "explore-graph",
        "isExternal": false,
@ -500,14 +492,6 @@
            "isExternal": true,
            "children": [],
            "disableCollapsible": false
-          },
-          {
-            "name": "Set up Nx Cloud On-Premise",
-            "path": "/ci/features/on-premise",
-            "id": "on-premise",
-            "isExternal": true,
-            "children": [],
-            "disableCollapsible": false
          }
        ],
        "disableCollapsible": false
@ -560,14 +544,6 @@
        "children": [],
        "disableCollapsible": false
      },
-      {
-        "name": "Set up Nx Cloud On-Premise",
-        "path": "/ci/features/on-premise",
-        "id": "on-premise",
-        "isExternal": true,
-        "children": [],
-        "disableCollapsible": false
-      },
      {
        "name": "Concepts",
        "path": "/concepts",
@ -5307,14 +5283,6 @@
            "isExternal": false,
            "children": [],
            "disableCollapsible": false
-          },
-          {
-            "name": "Set up Nx Cloud On-Premise",
-            "path": "/ci/features/on-premise",
-            "id": "on-premise",
-            "isExternal": false,
-            "children": [],
-            "disableCollapsible": false
          }
        ],
        "disableCollapsible": false
@ -5367,14 +5335,6 @@
        "children": [],
        "disableCollapsible": false
      },
-      {
-        "name": "Set up Nx Cloud On-Premise",
-        "path": "/ci/features/on-premise",
-        "id": "on-premise",
-        "isExternal": false,
-        "children": [],
-        "disableCollapsible": false
-      },
      {
        "name": "Concepts",
        "path": "/ci/concepts",
@ -5605,6 +5565,14 @@
                "id": "on-premise",
                "isExternal": false,
                "children": [
+                  {
+                    "name": "Set up Nx Cloud On-Premise",
+                    "path": "/ci/recipes/enterprise/on-premise/on-premise",
+                    "id": "on-premise",
+                    "isExternal": false,
+                    "children": [],
+                    "disableCollapsible": false
+                  },
                  {
                    "name": "Authenticate with a Single Admin",
                    "path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
@ -6031,6 +5999,14 @@
            "id": "on-premise",
            "isExternal": false,
            "children": [
+              {
+                "name": "Set up Nx Cloud On-Premise",
+                "path": "/ci/recipes/enterprise/on-premise/on-premise",
+                "id": "on-premise",
+                "isExternal": false,
+                "children": [],
+                "disableCollapsible": false
+              },
              {
                "name": "Authenticate with a Single Admin",
                "path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
@ -6172,6 +6148,14 @@
        "id": "on-premise",
        "isExternal": false,
        "children": [
+          {
+            "name": "Set up Nx Cloud On-Premise",
+            "path": "/ci/recipes/enterprise/on-premise/on-premise",
+            "id": "on-premise",
+            "isExternal": false,
+            "children": [],
+            "disableCollapsible": false
+          },
          {
            "name": "Authenticate with a Single Admin",
            "path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
@ -6247,6 +6231,14 @@
        ],
        "disableCollapsible": false
      },
+      {
+        "name": "Set up Nx Cloud On-Premise",
+        "path": "/ci/recipes/enterprise/on-premise/on-premise",
+        "id": "on-premise",
+        "isExternal": false,
+        "children": [],
+        "disableCollapsible": false
+      },
      {
        "name": "Authenticate with a Single Admin",
        "path": "/ci/recipes/enterprise/on-premise/auth-single-admin",
--- a/docs/generated/manifests/nx.json
+++ b/docs/generated/manifests/nx.json
@ -385,7 +385,7 @@
      },
      {
        "id": "explore-graph",
-        "name": "Explore your Workspace",
+        "name": "Explore Your Workspace",
        "description": "",
        "mediaImage": "",
        "file": "shared/features/explore-graph",
@ -510,17 +510,6 @@
            "isExternal": true,
            "path": "/ci/features/flaky-tasks",
            "tags": []
-          },
-          {
-            "id": "on-premise",
-            "name": "Set up Nx Cloud On-Premise",
-            "description": "Set up Nx Cloud on machines that you control",
-            "mediaImage": "",
-            "file": "",
-            "itemList": [],
-            "isExternal": true,
-            "path": "/ci/features/on-premise",
-            "tags": []
          }
        ],
        "isExternal": false,
@ -556,7 +545,7 @@
  },
  "/features/explore-graph": {
    "id": "explore-graph",
-    "name": "Explore your Workspace",
+    "name": "Explore Your Workspace",
    "description": "",
    "mediaImage": "",
    "file": "shared/features/explore-graph",
@ -681,17 +670,6 @@
        "isExternal": true,
        "path": "/ci/features/flaky-tasks",
        "tags": []
-      },
-      {
-        "id": "on-premise",
-        "name": "Set up Nx Cloud On-Premise",
-        "description": "Set up Nx Cloud on machines that you control",
-        "mediaImage": "",
-        "file": "",
-        "itemList": [],
-        "isExternal": true,
-        "path": "/ci/features/on-premise",
-        "tags": []
      }
    ],
    "isExternal": false,
@ -764,17 +742,6 @@
    "path": "/ci/features/flaky-tasks",
    "tags": []
  },
-  "/ci/features/on-premise": {
-    "id": "on-premise",
-    "name": "Set up Nx Cloud On-Premise",
-    "description": "Set up Nx Cloud on machines that you control",
-    "mediaImage": "",
-    "file": "",
-    "itemList": [],
-    "isExternal": true,
-    "path": "/ci/features/on-premise",
-    "tags": []
-  },
  "/concepts": {
    "id": "concepts",
    "name": "Concepts",
--- a/docs/generated/manifests/tags.json
+++ b/docs/generated/manifests/tags.json
@ -248,7 +248,7 @@
      "description": "",
      "file": "shared/features/explore-graph",
      "id": "explore-graph",
-      "name": "Explore your Workspace",
+      "name": "Explore Your Workspace",
      "path": "/features/explore-graph"
    },
    {
@ -1134,7 +1134,7 @@
      "file": "nx-cloud/features/nx-enterprise-on-prem",
      "id": "on-premise",
      "name": "Set up Nx Cloud On-Premise",
-      "path": "/ci/features/on-premise"
+      "path": "/ci/recipes/enterprise/on-premise/on-premise"
    }
  ],
  "docker": [
--- a/docs/map.json
+++ b/docs/map.json
@ -99,7 +99,7 @@
              "file": "shared/features/cache-task-results"
            },
            {
-              "name": "Explore your Workspace",
+              "name": "Explore Your Workspace",
              "id": "explore-graph",
              "tags": ["explore-graph"],
              "file": "shared/features/explore-graph"
@ -179,14 +179,6 @@
                  "file": "",
                  "path": "/ci/features/flaky-tasks",
                  "isExternal": true
-                },
-                {
-                  "name": "Set up Nx Cloud On-Premise",
-                  "id": "on-premise",
-                  "description": "Set up Nx Cloud on machines that you control",
-                  "file": "",
-                  "path": "/ci/features/on-premise",
-                  "isExternal": true
                }
              ]
            }
@ -1633,13 +1625,6 @@
              "id": "flaky-tasks",
              "description": "Learn how Nx Cloud is able to automatically identify flaky tasks and re-run them for you.",
              "file": "nx-cloud/features/flaky-tasks"
-            },
-            {
-              "name": "Set up Nx Cloud On-Premise",
-              "description": "Set up Nx Cloud on machines that you control",
-              "id": "on-premise",
-              "tags": ["on-premise"],
-              "file": "nx-cloud/features/nx-enterprise-on-prem"
            }
          ]
        },
@ -1780,6 +1765,13 @@
                  "id": "on-premise",
                  "description": "Manage an on-premise installation of Nx Cloud",
                  "itemList": [
+                    {
+                      "name": "Set up Nx Cloud On-Premise",
+                      "description": "Set up Nx Cloud on machines that you control",
+                      "id": "on-premise",
+                      "tags": ["on-premise"],
+                      "file": "nx-cloud/features/nx-enterprise-on-prem"
+                    },
                    {
                      "name": "Authenticate with a Single Admin",
                      "id": "auth-single-admin",
--- a/docs/shared/reference/sitemap.md
+++ b/docs/shared/reference/sitemap.md
@ -16,7 +16,7 @@
  - [Features](/features)
    - [Run Tasks](/features/run-tasks)
    - [Cache Task Results](/features/cache-task-results)
-    - [Explore your Workspace](/features/explore-graph)
+    - [Explore Your Workspace](/features/explore-graph)
    - [Generate Code](/features/generate-code)
    - [Automate Updating Dependencies](/features/automate-updating-dependencies)
    - [Enforce Module Boundaries](/features/enforce-module-boundaries)
@ -255,7 +255,6 @@
    - [Dynamically Allocate Agents](/ci/features/dynamic-agents)
    - [Automatically Split E2E Tasks (Atomizer)](/ci/features/split-e2e-tasks)
    - [Identify and Re-run Flaky Tasks](/ci/features/flaky-tasks)
-    - [Set up Nx Cloud On-Premise](/ci/features/on-premise)
  - [Concepts](/ci/concepts)
    - [The Building Blocks of Fast CI](/ci/concepts/building-blocks-fast-ci)
    - [Reduce Wasted Time in CI](/ci/concepts/reduce-waste)
@ -281,6 +280,7 @@
      - [Enable Azure DevOps PR Integration](/ci/recipes/source-control-integration/azure-devops)
    - [Enterprise](/ci/recipes/enterprise)
      - [On-Premise](/ci/recipes/enterprise/on-premise)
+        - [Set up Nx Cloud On-Premise](/ci/recipes/enterprise/on-premise/on-premise)
        - [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
        - [Authenticate with GitHub](/ci/recipes/enterprise/on-premise/auth-github)
        - [On-Prem VM Setup](/ci/recipes/enterprise/on-premise/ami-setup)
--- a/nx-dev/data-access-menu/src/lib/menu.utils.ts
+++ b/nx-dev/data-access-menu/src/lib/menu.utils.ts
@ -95,7 +95,8 @@ export function getBasicNxCloudSection(items: MenuItem[]): MenuSection {
      .map((m) => {
        return {
          ...m,
-          disableCollapsible: !m.id.endsWith('tutorial'),
+          disableCollapsible:
+            !m.id.endsWith('tutorial') && !m.id.endsWith('concepts'),
        };
      }),
  };
--- a/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts
+++ b/nx-dev/nx-dev-e2e/src/nx-cloud-documentation.spec.ts
@ -32,7 +32,7 @@ const pages: Array<{ title: string; path: string }> = [
  },
  {
    title: 'Running Nx Cloud Enterprise',
-    path: '/ci/features/on-premise',
+    path: '/ci/recipes/enterprise/on-premise/on-premise',
  },
  {
    title: 'Auth (Basic)',
--- a/nx-dev/nx-dev/redirect-rules.js
+++ b/nx-dev/nx-dev/redirect-rules.js
@ -426,7 +426,9 @@ const nxCloudUrls = {
    '/nx-cloud/features/distribute-task-execution',
  '/concepts/affected': '/ci/features/affected',
  '/nx-cloud/private-cloud': '/ci/recipes/enterprise/on-premise',
-  '/nx-cloud/private-cloud/get-started': '/ci/features/on-premise',
+  '/nx-cloud/private-cloud/get-started':
+    '/ci/recipes/enterprise/on-premise/on-premise',
+  '/ci/features/on-premise': '/ci/recipes/enterprise/on-premise/on-premise',
  '/nx-cloud/private-cloud/auth-single-admin':
    '/nx-cloud/recipes/enterprise/on-premise/auth-single-admin',
  '/nx-cloud/private-cloud/auth-github':
--- a/nx-dev/ui-common/src/lib/headers/menu-items.ts
+++ b/nx-dev/ui-common/src/lib/headers/menu-items.ts
@ -9,7 +9,9 @@ import {
  PlayCircleIcon,
  ShareIcon,
  Squares2X2Icon,
+  RectangleGroupIcon,
  ChatBubbleBottomCenterTextIcon,
+  ArrowUpCircleIcon,
 } from '@heroicons/react/24/outline';
 import { FC, SVGProps } from 'react';
 import { NxAgentsIcon } from '../nx-agents-icon';
@ -27,7 +29,7 @@ export interface MenuItem {

 export const featuresItems: MenuItem[] = [
  {
-    name: 'Task Running',
+    name: 'Run Tasks',
    // description: 'Run one or many tasks in parallel.',
    description: null,
    href: '/features/run-tasks',
@ -36,7 +38,7 @@ export const featuresItems: MenuItem[] = [
    isHighlight: false,
  },
  {
-    name: 'Local Caching',
+    name: 'Cache Task Results',
    // description: 'Speeds up your local workflow.',
    description: null,
    href: '/features/cache-task-results',
@ -45,7 +47,7 @@ export const featuresItems: MenuItem[] = [
    isHighlight: false,
  },
  {
-    name: 'Nx Graph',
+    name: 'Explore Your Workspace',
    // description: 'See interactions for tasks and modules.',
    description: null,
    href: '/features/explore-graph',
@ -54,16 +56,16 @@ export const featuresItems: MenuItem[] = [
    isHighlight: false,
  },
  {
-    name: 'Automated updates',
+    name: 'Automate Updating Dependencies',
    // description: 'Keep running on latest without effort.',
    description: null,
    href: '/features/automate-updating-dependencies',
-    icon: ArrowPathIcon,
+    icon: ArrowUpCircleIcon,
    isNew: false,
    isHighlight: false,
  },
  {
-    name: 'Module Boundaries',
+    name: 'Enforce Module Boundaries',
    // description: 'Partition your code into defined units.',
    description: null,
    href: '/features/enforce-module-boundaries',
@ -72,16 +74,16 @@ export const featuresItems: MenuItem[] = [
    isHighlight: false,
  },
  {
-    name: 'Nx Release',
+    name: 'Manage Releases',
    // description: 'Versioning, changelog, publishing.',
    description: null,
    href: '/features/manage-releases',
    icon: CubeIcon,
-    isNew: true,
+    isNew: false,
    isHighlight: false,
  },
  {
-    name: 'Nx Replay',
+    name: 'Use Remote Caching (Nx Replay)',
    description: 'Zero-config, fast & secure remote cache solution.',
    href: '/ci/features/remote-cache',
    icon: NxReplayIcon,
@ -89,12 +91,12 @@ export const featuresItems: MenuItem[] = [
    isHighlight: true,
  },
  {
-    name: 'Nx Agents',
+    name: 'Distribute Task Execution (Nx Agents)',
    description:
-      'One-line config for distributing tasks, E2E tests split & flaky tasks rerun.',
+      'One-line config for distributing tasks across multiple machines',
    href: '/ci/features/distribute-task-execution',
    icon: NxAgentsIcon,
-    isNew: true,
+    isNew: false,
    isHighlight: true,
  },
 ];