Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix and clean up menu structure #2422

Merged
merged 14 commits into from
Dec 13, 2024
10 changes: 9 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Empty file removed src/.hugo_build.lock
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file shouldn't be in the repo

Empty file.
40 changes: 7 additions & 33 deletions src/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ markup:
lineNos: false

menu:
# main is our Vintage menu
main:
- identifier: platform-overview
name: Platform Overview
Expand All @@ -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
Expand Down
5 changes: 4 additions & 1 deletion src/content/changes/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 4 additions & 1 deletion src/content/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
5 changes: 4 additions & 1 deletion src/content/overview/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/content/overview/architecture/_index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
1 change: 1 addition & 0 deletions src/content/overview/connectivity/_index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion src/content/overview/fleet-management/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/content/overview/introduction/_index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
---

Check warning on line 1 in src/content/overview/observability/logging/index.md

View workflow job for this annotation

GitHub Actions / Files moved or deleted

File moved

File moved/renamed
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
Expand Down
4 changes: 2 additions & 2 deletions src/content/overview/security/domain-allowlist/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions src/content/reference/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 4 additions & 1 deletion src/content/support/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading
Loading