From 0ea034211eb6d0332ebef13190bc92ec45b3cdc9 Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Tue, 24 Sep 2024 10:02:33 +0200 Subject: [PATCH 1/2] Adds banners under the main menu for doc pages Based on the solution used on the opentelemetry site --- assets/scss/_styles_project.scss | 34 ++++++++++++++++++++++++ content/announcements/_index.md | 6 +++++ content/announcements/kubecon-na-2024.md | 6 +++++ content/docs/_index.md | 2 ++ layouts/docs/baseof.html | 1 + layouts/partials/banner.html | 10 +++++++ 6 files changed, 59 insertions(+) create mode 100644 content/announcements/_index.md create mode 100644 content/announcements/kubecon-na-2024.md create mode 100644 layouts/partials/banner.html diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index d91c74b52..21ccfd9aa 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -63,3 +63,37 @@ assets/scss/_styles_project.scss .tab-body { padding: 0rem; } + +// Styling for announcement banner +.menu-banner { + @include media-breakpoint-up(md) { + width: 100%; + position: fixed; + margin-left: -15px; + z-index: 31; + top: 4rem; + } + + //--td-pre-bg: #{adjust-color($gray-900, $lightness: -2.5%)}; + --td-pre-bg: black; + + background: var(--td-pre-bg); + color: var(--bs-body-color); + text-align: center; + height: 24px; + + & p { + // padding: 0.5rem; + // margin-bottom: initial; + color: white; + } +} + +// Adds a padding because the announcements banner is too close to the breadcrumb +header { + padding-bottom: 8px; +} +.td-page-meta { + // Adds a margin because the announcements banner is too close + margin-top: 16px; +} \ No newline at end of file diff --git a/content/announcements/_index.md b/content/announcements/_index.md new file mode 100644 index 000000000..b0b91be66 --- /dev/null +++ b/content/announcements/_index.md @@ -0,0 +1,6 @@ +--- +title: Announcements +cascade: + type: docs +headless: true +--- \ No newline at end of file diff --git a/content/announcements/kubecon-na-2024.md b/content/announcements/kubecon-na-2024.md new file mode 100644 index 000000000..0adc13bdb --- /dev/null +++ b/content/announcements/kubecon-na-2024.md @@ -0,0 +1,6 @@ +--- +title: Observability Day North America +expiryDate: 2024-11-15 +weight: -1 # top +--- + Meet us at [**Observability Day North America**](https://colocatedeventsna2024.sched.com/event/1iztP/turn-the-volume-down-on-noisy-neighbors-sandor-guba-axoflow) (part of KubeCon) in Salt Lake City on November 12! diff --git a/content/docs/_index.md b/content/docs/_index.md index 6f5508af2..80e29da1c 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -1,6 +1,8 @@ --- title: Logging operator weight: 400 +cascade: + show_banner: true --- Welcome to the Logging operator documentation! diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 9aaeb472b..1fad0fbd1 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -6,6 +6,7 @@
{{ partial "navbar.html" . }} + {{- partial "banner.html" . }}
diff --git a/layouts/partials/banner.html b/layouts/partials/banner.html new file mode 100644 index 000000000..cc12d2063 --- /dev/null +++ b/layouts/partials/banner.html @@ -0,0 +1,10 @@ +{{ if .Params.show_banner -}} + {{ $announcements := site.GetPage "announcements" -}} + {{ if $announcements -}} +
+ {{ range $announcements.RegularPages }} +
{{ .Content }}
+ {{ end -}} +
+ {{ end -}} +{{ end -}} \ No newline at end of file From ac36a4bb6f12e7966d34efd4f26bbfe52a1daf9f Mon Sep 17 00:00:00 2001 From: Robert Fekete Date: Tue, 24 Sep 2024 10:08:09 +0200 Subject: [PATCH 2/2] Corrections --- layouts/docs/baseof.html | 1 - layouts/partials/navbar.html | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 1fad0fbd1..9aaeb472b 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -6,7 +6,6 @@
{{ partial "navbar.html" . }} - {{- partial "banner.html" . }}
diff --git a/layouts/partials/navbar.html b/layouts/partials/navbar.html index 0d3c1de61..82d7172a0 100644 --- a/layouts/partials/navbar.html +++ b/layouts/partials/navbar.html @@ -62,4 +62,5 @@
{{ partial "search-input.html" . }}
+ {{- partial "banner.html" . }}