Skip to content

Commit

Permalink
[docs] Docs navigation improvements (#769)
Browse files Browse the repository at this point in the history
* [docs] Docs navigation improvements:
- Added a new list page for the how-to section
- Make 'GET STARTED' main menu item a drop down.
  • Loading branch information
manugarg committed Jun 10, 2024
1 parent 2cb5350 commit 5719d19
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 4 deletions.
22 changes: 20 additions & 2 deletions docs/config/_default/menus/menus.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@
url = "/docs/overview/cloudprober"
weight = 30

[[main]]
name = "Overview"
weight = 31
url = "/docs/overview/cloudprober"
parent = "get-started"

[[main]]
name = "Getting Started"
weight = 32
url = "/docs/overview/getting-started"
parent = "get-started"

[[main]]
name = "What is a Probe"
weight = 33
url = "/docs/overview/probe"
parent = "get-started"

[[main]]
name = "Configuration"
weight = 40
Expand All @@ -14,7 +32,7 @@
name = "How-To"
weight = 60
identifier = "how-to"
url = "/docs/how-to/external-probe"
url = "/docs/how-to/list/"

[[main]]
name = "Surfacers"
Expand Down Expand Up @@ -57,7 +75,7 @@
[[docs]]
name = "How-To"
identifier = "how-to"
url = "/docs/how-to/external-probe"
url = "/docs/how-to/list/"
weight = 30

[[docs]]
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/how-to/built-in-servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
menu:
docs:
parent: "how-to"
weight: 32
weight: 40
title: "Built-in Servers"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/how-to/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
menu:
docs:
parent: "how-to"
weight: 40
weight: 32
title: "Extending Cloudprober"
---

Expand Down
19 changes: 19 additions & 0 deletions docs/content/docs/how-to/list/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "How Tos"
lead: ""
draft: false
images: []
weight: 100
---

- [External Probe]({{< ref "external-probe" >}})
- [Alerting]({{< ref "alerting" >}})
- [Targets]({{< ref "targets" >}})
- [Kubernetes Targets]({{< ref "k8s_targets" >}})
- [Running on Kubernetes]({{< ref "run-on-kubernetes" >}})
- [Additional Labels]({{< ref "additional-labels" >}})
- [Validators]({{< ref "validators" >}})
- [Percentiles and Histograms]({{< ref "percentiles" >}})
- [Extending Cloudprober]({{< ref "extensions" >}})
- [Built-in Servers]({{< ref "built-in-servers" >}})
- [Resource Discovery Service]({{< ref "rds" >}})

0 comments on commit 5719d19

Please sign in to comment.