Fix and clean up menu structure (#2422)

giantswarm · Dec 13, 2024 · 07a3288 · 07a3288
1 parent 43a2626
commit 07a3288
Show file tree

Hide file tree

Showing 46 changed files with 114 additions and 99 deletions.
diff --git a/Makefile b/Makefile
@@ -130,7 +130,15 @@ docker-run:
 	docker run --rm -ti -p 8080:8080 $(REGISTRY)/$(COMPANY)/$(PROJECT):latest
 
 dev:
-	hugo server -s src
+	hugo server \
+	  --source ./src \
+	  --ignoreCache \
+	  --disableFastRender \
+	  --cleanDestinationDir \
+	  --gc \
+	  --noBuildLock \
+	  --noHTTPCache \
+	  --renderToMemory
 
 clean:
 	rm -rf build

diff --git a/src/.hugo_build.lock b/src/.hugo_build.lock
diff --git a/src/config.yaml b/src/config.yaml
@@ -22,6 +22,7 @@ markup:
     lineNos: false
 
 menu:
+  # main is our Vintage menu
   main:
   - identifier: platform-overview
     name: Platform Overview
@@ -39,39 +40,12 @@ menu:
     name: Use the API
     url: /vintage/use-the-api/
     weight: 40
-  - identifier: support
-    name: Support & Training
-    url: /support/
-    weight: 50
-  - identifier: changes
-    name: Changes and releases
-    url: /changes/
-    weight: 90
-  principal:
-  - identifier: overview
-    name: Overview
-    url: /overview/
-    weight: 10
-  - identifier: getting-started
-    name: Getting started
-    url: /getting-started/
-    weight: 20
-  - identifier: tutorials
-    name: Tutorials
-    url: /tutorials/
-    weight: 30
-  - identifier: reference
-    name: Reference
-    url: /reference/
-    weight: 40
-  - identifier: support
-    name: Support
-    url: /support/
-    weight: 50
-  - identifier: changes
-    name: Changes and releases
-    url: /changes/
-    weight: 90
+
+
+  # principal is the main menu since December 2024.
+  # Entries are assigned via front-matter.
+  principal: []
+
 
 taxonomies:
   changes_category: changes_categories

diff --git a/src/content/changes/_index.md b/src/content/changes/_index.md
@@ -1,7 +1,10 @@
 ---
 title: Changes and Releases
 description: Updates on Giant Swarm workload cluster releases, apps, UI improvements and documentation changes.
-weight: 10
+menu:
+  principal:
+    identifier: changes
+weight: 90
 last_review_date: 2024-02-23
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/getting-started/_index.md b/src/content/getting-started/_index.md
@@ -1,7 +1,10 @@
 ---
 title: Getting started
 description: Step-by-step customer journey to build your cloud-native developer platform.
-weight: 80
+menu:
+  principal:
+    identifier: getting-started
+weight: 20
 last_review_date: 2024-04-05
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/getting-started/prepare-your-provider-infrastructure/aws/_index.md b/src/content/getting-started/prepare-your-provider-infrastructure/aws/_index.md
@@ -1,8 +1,12 @@
 ---
 title: Prepare your AWS account
+linkTitle: AWS
 description: Prepare your AWS account to start building your cloud-native developer platform with Giant Swarm.
 weight: 10
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/team-phoenix
 user_questions:

diff --git a/src/content/getting-started/prepare-your-provider-infrastructure/azure/_index.md b/src/content/getting-started/prepare-your-provider-infrastructure/azure/_index.md
@@ -1,9 +1,12 @@
 ---
 title: Prepare your provider account for Azure
-linkTitle: Prepare your Azure account
+linkTitle: Azure
 description: Prepare your Azure account to start building your cloud-native developer platform with Giant Swarm.
 weight: 20
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/team-phoenix
 user_questions:

diff --git a/...ng-started/prepare-your-provider-infrastructure/vmware-cloud-director/_index.md b/...ng-started/prepare-your-provider-infrastructure/vmware-cloud-director/_index.md
@@ -1,9 +1,12 @@
 ---
 title: Prepare your provider environment for VMware Cloud Director
-linkTitle: Prepare your VCD environment
-description: Prepare your VMware Cloud Director setup to start building your cloud-native developer platform with Giant Swarm.
+linkTitle: VMware Cloud Director
+description: Prepare your VMware Cloud Director (VCD) setup to start building your cloud-native developer platform with Giant Swarm.
 weight: 30
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs
 user_questions:

diff --git a/...t/getting-started/prepare-your-provider-infrastructure/vmware-vsphere/_index.md b/...t/getting-started/prepare-your-provider-infrastructure/vmware-vsphere/_index.md
@@ -1,9 +1,12 @@
 ---
 title: Prepare your provider environment for VMware vSphere
-linkTitle: Prepare your vSphere environment
+linkTitle: VMware vSphere
 description: Prepare your VMware vSphere setup to start building your cloud-native developer platform with Giant Swarm.
 weight: 40
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs
 user_questions:

diff --git a/src/content/overview/_index.md b/src/content/overview/_index.md
@@ -1,7 +1,10 @@
 ---
 title: Overview
 description: Description of how our Cloud Native Developer Platform looks like and the services that Giant Swarm offer on top.
-weight: 100
+menu:
+  principal:
+    identifier: overview
+weight: 10
 last_review_date: 2024-03-07
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/overview/architecture/_index.md b/src/content/overview/architecture/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Architecture of the Giant Swarm cloud-native developer platform
-linkTitle: Architecture of the platform
+linkTitle: Architecture
 description: Components, capabilities, supported cloud providers, and the platform API.
 weight: 20
 menu:

diff --git a/...iew/architecture/authentication/_index.md → ...view/architecture/authentication/index.md b/...iew/architecture/authentication/_index.md → ...view/architecture/authentication/index.md
diff --git a/src/content/overview/architecture/operational-layers/index.md b/src/content/overview/architecture/operational-layers/index.md
@@ -2,10 +2,11 @@
 linkTitle: Operational layers
 title: Giant Swarm operational layers
 description: Here you learn how the operational layers of Giant Swarm are defined and what the intended operational model is.
-weight: 20
+weight: 10
 menu:
-  main:
-    parent: platform-overview-security
+  principal:
+    parent: overview-architecture
+    identifier: overview-architecture-operational-layers
 last_review_date: 2024-12-04
 user_questions:
   - What are the Giant Swarm operational layers?

diff --git a/src/content/overview/connectivity/_index.md b/src/content/overview/connectivity/_index.md
@@ -1,5 +1,6 @@
 ---
 title: Connectivity
+linkTitle: Connectivity
 description: Public or private access to your workload applications through ingress. Secure connections between your distributed applications or microservices through a API gateway.
 weight: 70
 menu:

diff --git a/src/content/overview/fleet-management/_index.md b/src/content/overview/fleet-management/_index.md
@@ -5,7 +5,7 @@ weight: 40
 menu:
   principal:
     parent: overview
-    identifier: overview-fleet-management
+    identifier: overview-fleetmanagement
 last_review_date: 2024-06-03
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-product

diff --git a/src/content/overview/fleet-management/app-management/index.md b/src/content/overview/fleet-management/app-management/index.md
@@ -5,8 +5,8 @@ description: The app platform allows to manage app catalogs and apps, for simple
 weight: 40
 menu:
   principal:
-    parent: overview-fleet-management
-    identifier: overview-fleet-management-app-platform
+    parent: overview-fleetmanagement
+    identifier: overview-fleetmanagement-appmanagement
 owner:
   - https://github.com/orgs/giantswarm/teams/team-honeybadger
 user_questions:

diff --git a/src/content/overview/fleet-management/cluster-management/_index.md b/src/content/overview/fleet-management/cluster-management/_index.md
@@ -4,8 +4,8 @@ description: Supported cloud providers and management of clusters on the Giant S
 weight: 30
 menu:
   principal:
-    parent: overview-fleet-management
-    identifier: overview-fleet-management-clusters
+    parent: overview-fleetmanagement
+    identifier: overview-fleetmanagement-clustermanagement
 last_review_date: 2024-05-02
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-product

diff --git a/...content/overview/fleet-management/cluster-management/cluster-concepts/_index.md b/...content/overview/fleet-management/cluster-management/cluster-concepts/_index.md
@@ -1,11 +1,12 @@
 ---
 title: Main cluster concepts
+linkTitle: Concepts
 description: Overview of the main concepts of cluster management in the Giant Swarm platform.
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-clusters
-    identifier: overview-fleet-management-cluster-concepts
+    parent: overview-fleetmanagement-clustermanagement
+    identifier: overview-fleetmanagement-clustermanagement-concepts
 last_review_date: 2024-06-26
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...-management/cluster-management/cluster-concepts/cluster-configuration/_index.md b/...-management/cluster-management/cluster-concepts/cluster-configuration/_index.md
@@ -4,8 +4,8 @@ description: Explanation of how cluster configuration works in Cluster API and h
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-configuration
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-configuration
 last_review_date: 2024-08-28
 owner:
   - https://github.com/orgs/giantswarm/teams/team-phoenix

diff --git a/...w/fleet-management/cluster-management/cluster-concepts/cluster-naming/_index.md b/...w/fleet-management/cluster-management/cluster-concepts/cluster-naming/_index.md
@@ -4,8 +4,8 @@ description: The specifications for naming workload clusters in the Giant Swarm
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-naming
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-naming
 last_review_date: 2024-06-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...ew/fleet-management/cluster-management/cluster-concepts/multi-account/_index.md b/...ew/fleet-management/cluster-management/cluster-concepts/multi-account/_index.md
@@ -4,8 +4,8 @@ description: Learn the advantages of using multi-account clusters in the Giant S
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-multi-account
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-multiaccount
 last_review_date: 2024-07-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...ew/fleet-management/cluster-management/cluster-concepts/organizations/_index.md b/...ew/fleet-management/cluster-management/cluster-concepts/organizations/_index.md
@@ -4,8 +4,8 @@ description: Organizations in the Giant Swarm platform allow isolation and logic
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-organizations
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-organizations
 last_review_date: 2024-07-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...fleet-management/cluster-management/cluster-concepts/private-clusters/_index.md b/...fleet-management/cluster-management/cluster-concepts/private-clusters/_index.md
@@ -4,8 +4,8 @@ description: Definition of what do we mean by private clusters in the Giant Swar
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-private
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-private
 last_review_date: 2024-06-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...content/overview/fleet-management/cluster-management/installation-name/index.md b/...content/overview/fleet-management/cluster-management/installation-name/index.md
@@ -1,12 +1,12 @@
 ---
-linkTitle: Installation names
+linkTitle: Installation name
 title: Picking an installation name
 description: Every Giant Swarm installation has a unique name. Learn the rules to select a proper name for a new installation.
 weight: 100
 menu:
   principal:
-    parent: overview-fleet-management-clusters
-    identifier: overview-fleet-management-clusters-installation-name
+    parent: overview-fleetmanagement-clustermanagement
+    identifier: overview-fleetmanagement-clustermanagement-installationname
 user_questions:
   - How do I determine the name for my Giant Swarm installation / management cluster?
 owner:

diff --git a/...overview/fleet-management/cluster-management/introduction-cluster-api/_index.md b/...overview/fleet-management/cluster-management/introduction-cluster-api/_index.md
@@ -4,8 +4,8 @@ description: How the Giant Swarm platform leverages the Cluster API standard for
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-clusters
-    identifier: overview-fleet-management-introduction-to-cluster-api
+    parent: overview-fleetmanagement-clustermanagement
+    identifier: overview-fleetmanagement-clustermanagement-capi
 last_review_date: 2024-05-02
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/overview/fleet-management/multi-tenancy/_index.md b/src/content/overview/fleet-management/multi-tenancy/_index.md
@@ -4,8 +4,8 @@ description: Manage cluster and application resources across multiple organizati
 weight: 40
 menu:
   principal:
-    parent: overview-fleet-management
-    identifier: overview-fleet-management-multi-tenancy
+    parent: overview-fleetmanagement
+    identifier: overview-fleetmanagement-multitenancy
 last_review_date: 2024-07-17
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-product

diff --git a/src/content/overview/introduction/_index.md b/src/content/overview/introduction/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Introduction to Giant Swarm and the Giant Swarm platform
-linkTitle: Introduction to Giant Swarm
+linkTitle: Introduction
 description: Giant Swarm gives platform engineering teams the ability to build cloud-native developer platforms and operate them without much hassle.
 weight: 10
 menu:

diff --git a/...servability/logging/architecture/index.md → ...t/overview/observability/logging/index.md b/...servability/logging/architecture/index.md → ...t/overview/observability/logging/index.md
@@ -1,12 +1,9 @@
 ---
-linkTitle: Logging architecture
-title: Logging architecture
+linkTitle: Logging
+title: Logging
 description: Documentation on the logging architecture deployed and maintained by Giant Swarm.
 weight: 80
 menu:
-  main:
-    identifier: getting-started-observability-logging-architecture
-    parent: getting-started-observability-logging
   principal:
     identifier: overview-observability-logging
     parent: overview-observability

diff --git a/...ing/architecture/logging-architecture.png → ...vability/logging/logging-architecture.png b/...ing/architecture/logging-architecture.png → ...vability/logging/logging-architecture.png
diff --git a/src/content/overview/security/domain-allowlist/_index.md b/src/content/overview/security/domain-allowlist/_index.md
@@ -3,8 +3,8 @@ description: A list of all external domains Giant Swarm clusters need access to
 last_review_date: 2024-11-29
 linkTitle: Domain allowlist
 menu:
-  main:
-    parent: platform-overview-security-cluster
+  principal:
+    parent: overview-security
 owner:
   - https://github.com/orgs/giantswarm/teams/team-teddyfriends
 title: Domain allowlist

diff --git a/src/content/reference/_index.md b/src/content/reference/_index.md
@@ -1,6 +1,10 @@
 ---
 title: Reference
 description: Technical documentation about our apps, tools and interfaces. Users can find API schema, CLIs, Chart references and more.
+menu:
+  principal:
+    identifier: reference
+weight: 40
 last_review_date: 2024-10-29
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/support/_index.md b/src/content/support/_index.md
@@ -1,7 +1,10 @@
 ---
 title: Support
 description: How our support model works and how our operation team handles the incidents.
-weight: 40
+menu:
+  principal:
+    identifier: support
+weight: 50
 last_review_date: 2024-11-28
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs