Move API content to the new toplevel API section, link the TopNav and light it up in the search

.github/CODEOWNERS

@@ -325,51 +325,27 @@
 
 # updates to the octopus rest api overview page are reviewed by team-marketing
 
-/docs/octopus-rest-api/index.mdx @OctopusDeploy/team-marketing
+/docs/api/index.mdx @OctopusDeploy/team-marketing
 
 # updates to the how to create an api key page are reviewed by team-backend-foundations
 
-/docs/octopus-rest-api/how-to-create-an-api-key.md @OctopusDeploy/team-backend-foundations
+/docs/api/how-to-create-an-api-key.md @OctopusDeploy/team-backend-foundations
 
 # updates to the octopus client page are reviewed by team-backend-foundations
 
-/docs/octopus-rest-api/octopus.client/index.md @OctopusDeploy/team-backend-foundations
+/docs/api/octopus.client/index.md @OctopusDeploy/team-backend-foundations
 
 # updates to the octopus command line sections are reviewed by team-modern-deployments
 
-/docs/octopus-rest-api/octopus-cli/ @OctopusDeploy/team-modern-deployments
-
-# updates to the API examples page are reviewed by team-backend-foundations
-
-/docs/octopus-rest-api/examples/index.md @OctopusDeploy/team-backend-foundations
-
-# updates to the octopus server command line page are reviewed by team-backend-foundations
-
-/docs/octopus-rest-api/octopus.server.exe-command-line/index.md @OctopusDeploy/team-backend-foundations
-
-# updates to the octopus rest api tentacle exe command line page are reviewed by team-executions-foundations
-
-/docs/octopus-rest-api/tentacle.exe-command-line/index.md @OctopusDeploy/team-executions-foundations
-
-# updates to the calamari page are reviewed by team-modern-deployments
-
-/docs/octopus-rest-api/calamari.md @OctopusDeploy/team-modern-deployments
-
-# updates to the octopus migrator command line page are reviewed by team-backend-foundations
-
-/docs/octopus-rest-api/octopus.migrator.exe-command-line/index.md @OctopusDeploy/team-backend-foundations
-
-# updates to the migration api page are reviewed by team-backend-foundations
-
-/docs/octopus-rest-api/migration-api/index.md @OctopusDeploy/team-backend-foundations
+/docs/api/octopus-cli/ @OctopusDeploy/team-modern-deployments
 
 # updates to the octopus CLI sections are reviewed by team-modern-deployments
 
-/docs/octopus-rest-api/cli/ @OctopusDeploy/team-modern-deployments
+/docs/cli/ @OctopusDeploy/team-modern-deployments
 
 # updates to the openid connect page are reviewed by team-devex
 
-/docs/octopus-rest-api/openid-connect/ @OctopusDeploy/team-devex
+/docs/api/openid-connect/ @OctopusDeploy/team-devex
 
 # updates to the administration section are reviewed by team-backend-foundations
 

package.json

@@ -15,14 +15,14 @@
         "dev:astro": "astro dev",
         "dev:watch": "onchange 'src/**/*.{js,mjs,ts,astro,css}' -- prettier --write --plugin=prettier-plugin-astro {{changed}}",
         "astro": "astro",
-        "build": "astro build",
+        "build": "node --max-old-space-size=8192 node_modules/astro/bin/astro.mjs build",
         "crawl": "linkinator ./dist --skip \"^(?!http://localhost)\" --recurse  --verbosity error",
         "format": "prettier --write --plugin=prettier-plugin-astro 'src/**/*.{js,mjs,ts,astro,css}'",
         "preview": "astro preview",
         "renovate": "renovate",
         "spellcheck": "git fetch origin main:refs/remotes/origin/main && git diff origin/main --name-only --diff-filter=ACMRTUXB | cspell --no-must-find-files --file-list stdin",
         "spellcheck-all": "cspell \"**/*.{md,mdx}\"",
-        "test": "astro build && npx playwright install chromium && npx playwright test",
+        "test": "node --max-old-space-size=8192 node_modules/astro/bin/astro.mjs build && npx playwright install chromium && npx playwright test",
         "watch": "onchange 'src/**/*.{js,mjs,ts,astro,css}' -- prettier --write --plugin=prettier-plugin-astro {{changed}}"
     },
     "dependencies": {

src/components/TopNav.astro

@@ -18,7 +18,7 @@ const {
   links = [
     { label: 'Docs', href: '/docs' },
     // TODO: { label: 'Learn', href: '/docs/?' },
-    { label: 'API', href: '/docs/octopus-rest-api' },
+    { label: 'API', href: '/docs/api' },
     { label: 'CLI', href: '/docs/cli' },
   ],
 } = Astro.props satisfies Props;

src/lib/searchIndexing.ts

@@ -5,7 +5,6 @@
 
 import type { Frontmatter } from 'astro-accelerator-utils/types/Frontmatter';
 import { classify } from '../scripts/search-engine';
-import { isUnderConstructionUrl } from './underConstruction';
 
 type ArticleAttributes = {
   'data-pagefind-ignore'?: string;
@@ -48,8 +47,7 @@ export function searchIndexAttributes(
   pathname: string,
   frontmatter: Frontmatter
 ): IndexAttributes {
-  const indexable =
-    frontmatter.navSearch !== false && !isUnderConstructionUrl(pathname);
+  const indexable = frontmatter.navSearch !== false;
 
   // `all` rather than the default `index`: a bare ignore still lets Pagefind
   // read a title or metadata out of the block.

src/pages/components.mdx

@@ -41,7 +41,7 @@ export const searchDemoResults = [
     facet: 'docs',
   },
   {
-    url: '/docs/octopus-rest-api/feeds/modify-a-feed',
+    url: '/docs/api/feeds/modify-a-feed',
     title: 'Modify a feed',
     excerpt:
       'Updates the specified <mark>feed</mark> by setting the values of the parameters passed.',

src/pages/docs/administration/high-availability/auto-scaling-high-availability-nodes.md

@@ -214,7 +214,7 @@ A task node is a node where the task cap is greater than 0.  By default, all nod
 
 While High Availability was designed to add nodes quickly, it was not designed to delete nodes quickly.  The assumption was made when a node went offline; it was for a server restart.  It was not designed to handle scale-in events from an auto-scaling technology automatically.
 
-Auto-scaling technologies don't let you run scripts directly on virtual machines as they are being deleted.  They will typically publish a message you can process.  Because of that, you'll need to leverage the [Octopus Deploy REST API](/docs/octopus-rest-api) to do the following:
+Auto-scaling technologies don't let you run scripts directly on virtual machines as they are being deleted.  They will typically publish a message you can process.  Because of that, you'll need to leverage the [Octopus Deploy REST API](/docs/api) to do the following:
 
 - Enable drain mode on the node.  While that is enabled, it will prevent the node from picking up new tasks and will attempt to finish in-process tasks.
 - Wait until either the node is marked offline or all tasks have finished processing.

src/pages/docs/administration/high-availability/how-high-availability-works.md

@@ -81,7 +81,7 @@ For planned outages, the recommendation is to enable drain mode.  That will tell
 
 Once the outage is finished, repeat the same steps, but select **Disable Drain Node** instead.
 
-Not all outages can be planned.  The underlying hypervisor hosting VM the node is running on could crash.  A data center could go offline.  When that happens you can use this [API Script](/docs/octopus-rest-api/examples/bulk-operations/rerun-deployments-and-runbooks-after-node-shutdown) to re-run those canceled deployments and runbook runs.
+Not all outages can be planned.  The underlying hypervisor hosting VM the node is running on could crash.  A data center could go offline.  When that happens you can use this [API Script](/docs/api/examples/bulk-operations/rerun-deployments-and-runbooks-after-node-shutdown) to re-run those canceled deployments and runbook runs.
 
 ### Number of nodes
 

src/pages/docs/administration/managing-infrastructure/rate-limiting.md

@@ -33,7 +33,7 @@ The rate limit applies per user.
 
 ### Authenticated AI Agent Requests
 
-This policy applies to any HTTP requests associated with an authenticated user which authenticate using an [agent API key](/docs/octopus-rest-api/how-to-create-an-api-key#creating-an-agent-api-key).
+This policy applies to any HTTP requests associated with an authenticated user which authenticate using an [agent API key](/docs/api/authentication/create-an-api-key#creating-an-agent-api-key).
 The rate limit applies per user, counted separately from non-AI requests.
 
 ### Webhook Trigger Requests

src/pages/docs/administration/managing-infrastructure/server-configuration/managing-configuration.md

@@ -20,7 +20,7 @@ In the Octopus Web Portal, you can access configuration by navigating to **Confi
 
 ## Octopus.Client
 
-Using [Octopus.Client](/docs/octopus-rest-api/octopus.client), each of the configuration types can be managed programmatically, reading from and writing back to the Octopus Deploy database.
+Using [Octopus.Client](/docs/api/octopus.client), each of the configuration types can be managed programmatically, reading from and writing back to the Octopus Deploy database.
 
 :::div{.hint}
 This requires version 15.2.0 or later of the client library.
@@ -67,4 +67,4 @@ $guestConfig.IsEnabled = $true;
 $guestConfig = $modifyMethod.Invoke($repo.Configuration, $guestConfig)
 ```
 
-For more information on using the Octopus.Client library see [Octopus.Client](/docs/octopus-rest-api/octopus.client).
+For more information on using the Octopus.Client library see [Octopus.Client](/docs/api/octopus.client).

src/pages/docs/administration/migrate-spaces-with-octoterra/index.md

@@ -93,8 +93,8 @@ These are the prerequisites for migrating an Octopus space with the Octoterra Wi
 - [Backup](https://octopus.com/docs/administration/data/backup-and-restore) your Octopus instance again before the migration.
 - Download the Octoterra Wizard from [GitHub](https://github.com/OctopusSolutionsEngineering/OctoterraWizard).
 - Install [Terraform](https://developer.hashicorp.com/terraform/install) on your local workstation.
-- [Create an API key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) for the source Octopus instance.
-- [Create an API key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) for the destination Octopus instance.
+- [Create an API key](https://octopus.com/docs/api/authentication/create-an-api-key) for the source Octopus instance.
+- [Create an API key](https://octopus.com/docs/api/authentication/create-an-api-key) for the destination Octopus instance.
 - Create a remote [Terraform backend](https://developer.hashicorp.com/terraform/language/settings/backends/configuration) to maintain the state of the Terraform resources. [AWS S3](https://developer.hashicorp.com/terraform/language/settings/backends/s3) and [Azure Storage Accounts](https://developer.hashicorp.com/terraform/language/settings/backends/azurerm) are supported.
 - Install any required local tools. See the "Local Tools vs Container Images" section for more details.
 
@@ -336,7 +336,7 @@ Any firewall rules relating to the Octopus server must be updated to reflect the
 
 ### Regenerate API keys
 
-Any external scripts and platforms to connect to the destination Octopus server must make use of a new [API key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key).
+Any external scripts and platforms to connect to the destination Octopus server must make use of a new [API key](https://octopus.com/docs/api/authentication/create-an-api-key).
 
 ### Reconfigure polling tentacles
 

src/pages/docs/administration/reporting/report-on-deployments-excel-template.md

@@ -59,7 +59,7 @@ The best way to consume reporting data from Octopus is using the XML feed. The f
 Where:
 
 - `<OCTOPUS-SERVER>` is the hostname of your Octopus Server
-- `<API-KEY>` is one of [your API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
+- `<API-KEY>` is one of [your API keys](/docs/api/authentication/create-an-api-key)
 
 For example:
 

src/pages/docs/administration/reporting/report-on-deployments-using-excel.md

@@ -24,7 +24,7 @@ At a high-level, the steps are:
 
 Before we can report on the data using Excel, we need to export it in a format that Excel can import. The easiest way to do this is using an XML file.
 
-Octopus exposes data on deployments through the `/api/reporting/deployments/xml` endpoint. You can use our [Octopus API clients](/docs/octopus-rest-api/getting-started#api-clients) to download the XML file.
+Octopus exposes data on deployments through the `/api/reporting/deployments/xml` endpoint. You can use our [Octopus API clients](/docs/api/#api-clients) to download the XML file.
 
 <details data-group="administration-reporting-report-on-deployments-using-excel-client">
 <summary>PowerShell</summary>

src/pages/docs/api-and-integration/api/how-to-create-an-api-key.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Redirect.astro
 title: Redirect
-redirect: https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key
+redirect: https://octopus.com/docs/api/authentication/create-an-api-key
 pubDate:  2023-01-01
 navSearch: false
 navSitemap: false

src/pages/docs/api-and-integration/examples/add-a-space-with-environments.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Redirect.astro
 title: Redirect
-redirect: https://octopus.com/docs/octopus-rest-api/examples/spaces/add-a-space-with-environments
+redirect: https://octopus.com/docs/api/examples/spaces/add-a-space-with-environments
 pubDate:  2023-01-01
 navSearch: false
 navSitemap: false

src/pages/docs/api-and-integration/examples/delete-a-space.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Redirect.astro
 title: Redirect
-redirect: https://octopus.com/docs/octopus-rest-api/examples/spaces/delete-a-space
+redirect: https://octopus.com/docs/api/examples/spaces/delete-a-space
 pubDate:  2023-01-01
 navSearch: false
 navSitemap: false

src/pages/docs/api-and-integration/examples/index.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Redirect.astro
 title: Redirect
-redirect: https://octopus.com/docs/octopus-rest-api/examples
+redirect: https://octopus.com/docs/api/examples
 pubDate:  2023-01-01
 navSearch: false
 navSitemap: false

src/pages/docs/api-and-integration/migration-api/index.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Redirect.astro
 title: Redirect
-redirect: https://octopus.com/docs/octopus-rest-api/migration-api
+redirect: https://octopus.com/docs/api/migrations
 pubDate:  2023-01-01
 navSearch: false
 navSitemap: false

src/pages/docs/api-and-integration/octopus.client.md

@@ -1,7 +1,7 @@
 ---
 layout: src/layouts/Redirect.astro
 title: Redirect
-redirect: https://octopus.com/docs/octopus-rest-api/octopus.client
+redirect: https://octopus.com/docs/api/octopus.client
 pubDate:  2023-01-01
 navSearch: false
 navSitemap: false