Chore: Merge branch 'main' into mainframe

Author: lamATnginx

.github/workflows/hugo-build-test.yml

@@ -0,0 +1,6 @@
+{{<banner "caution" "Under development">}}
+  <br>
+  This product on our example site is under development and changes are being added frequently. 
+  <br>
+  Please reach out to <strong>#friends-of-the-docs</strong> on Slack to ask questions.
+{{</banner>}}

exampleSite/_banners/test-product-intro.md

@@ -13,6 +13,11 @@ nd-content-type: landing-page
 # Intended for internal catalogue and search, case sensitive:
 # Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
 nd-product:
+cascade:
+  nd-banner:
+    enabled: true
+    start-date: 2025-01-01
+    md: /_banners/test-product-intro.md
 ---
 
 ## About

exampleSite/content/test-product/_index.md

@@ -13,20 +13,20 @@ The callout shortcode aims to support both, but **not** in the same shortcode in
 ## The two callouts below using **unnamed** params
 
 {{<call-out "" "Custom title" "fa fa-check-circle" "true">}}
-This callout uses the icon check-circle. **This should be an inline callout.**
+This callout uses the icon check-circle. **This should be an sideline callout.**
 {{</call-out>}}
 
 {{<call-out "" "Custom title" "fa fa-check-circle" "false">}}
-This callout uses the icon check-circle. **This should be an sideline callout.**
+This callout uses the icon check-circle. **This should be an inline callout.**
 {{</call-out>}}
 
 ## The two callouts below using **named** params
 This should work exactly the same as the two callouts above
 
-{{<call-out title="Custom title" icon="fa fa-check-circle" inline="true">}}
-This callout uses the icon check-circle. **This should be an inline callout.**
+{{<call-out title="Custom title" icon="fa fa-check-circle" sideline="true">}}
+This callout uses the icon check-circle. **This should be an sideline callout.**
 {{</call-out>}}
 
-{{<call-out title="Custom title" icon="fa fa-check-circle" inline="asdas">}}
+{{<call-out title="Custom title" icon="fa fa-check-circle" sideline="true">}}
 This callout uses the icon check-circle. **This should be an sideline callout.**
 {{</call-out>}}

exampleSite/content/test-product/call-out/call-out-param-types.md

@@ -46,6 +46,6 @@ This assumes the callout text is shorter than the text in the callout.
 If the text in the paragraph is shorter than the callout, it's likely
 the content needs to be re-written.
 
-{{<call-out "tip inline-callout" "Tip for Automated Reporting" >}}
+{{<call-out "tip" "Tip for Automated Reporting" >}}
 I am some call out text. Look at me go!
 {{</call-out>}}

exampleSite/content/test-product/call-out/call-out-side.md

@@ -2,49 +2,48 @@
 {{ $class := .class | default "" }}
 {{ $title := .title | default "" }}
 {{ $icon  := .icon  | default "" }}
-{{ $inlineParam := .inline | default "false" | lower }}
+{{ $sidelineParam := .sideline | default "false" | lower }}
 
-{{ if not (in (slice "true" "false") $inlineParam) }}
-  {{ errorf "Invalid parameter 'inline'='%s' passed to blockquote partial from '%s'. Allowed values: true, false" $inlineParam .Page.Path }}
+{{ if not (in (slice "true" "false") $sidelineParam) }}
+  {{ errorf "Invalid parameter 'sideline'='%s' passed to blockquote partial from '%s'. Allowed values: true, false" $sidelineParam .Page.Path }}
 {{ end }}
 
 {{/*  Figure out inline/side and set class accordingly  */}}
-{{ $inline := eq $inlineParam "true" }}
+{{ $sideline := eq $sidelineParam "true" }}
 {{ $sideOption := "side-callout" }}
 {{ $inlineOption := "inline-callout" }}
 
-{{ if $inline }}
+{{ if $sideline }}
   {{ $class = printf "%s %s" $class $sideOption }}
 {{ else }}
   {{ $class = printf "%s %s" $class $inlineOption }}
 {{ end }}
 
 {{/*  Render a different block, if "loud" callouts are used  */}}
+{{ $type := (index (split $class " ") 0) | strings.FirstUpper }}
 {{ $specialTitles := slice "Caution" "Warning" "Deprecated" "Important" }}
 {{ $specialTitleIcons := dict
   "Caution"    "alert-triangle"
   "Warning"    "alert-octagon"
   "Deprecated" "alert-octagon"
   "Important"  "arrow-right-circle"
 }}
-{{ $icon := index $specialTitleIcons $title | default "" }}
+{{ $icon := index $specialTitleIcons $type | default "" }}
 
-{{ $isSpecialTitle := in $specialTitles $title }}
+{{ $isSpecialTitle := in $specialTitles $type }}
 {{ if $isSpecialTitle }}
-  {{/*  Loud callouts  */}}
+{{/*  Loud callouts  */}}
+<blockquote class="{{ $class }}">
   <div>
-  <blockquote class="{{ $class }}">
-    <div>
-      <div class="call-out-type">
-        {{ partial "feather" (dict "context" . "icon" $icon) .}}
-       {{ $title }}
-      </div>
-      <div class="callout-content">
-        {{ .content | markdownify }}
-      </div>
+    <div class="call-out-type">
+      {{ partial "feather" (dict "context" . "icon" $icon) .}}
+      {{ $title }}
     </div>
-  </blockquote>
-</div>
+    <div class="callout-content">
+      {{ .content | markdownify }}
+    </div>
+  </div>
+</blockquote>
 
 {{ else }}
 

layouts/partials/callout.html

@@ -0,0 +1,21 @@
+<!-- Get the product name -->
+{{ $productUrl := .Page.Permalink }}
+{{ $baseUrl := .Site.BaseURL }}
+{{ $linkSplit := split (replace $productUrl $baseUrl "") "/" }}
+{{ $productName := index $linkSplit 0 }}
+<!-- Get the content -->
+{{ $changelogContent := readFile (printf "content/%s/changelog.md" $productName) }}
+{{ $maxNumLogs := 3 }}
+{{ $headings := first $maxNumLogs (findRE `(?m)^##\s(.+)$` $changelogContent) }}
+
+<ul>
+  {{ if gt (len $headings) 0 }}
+  {{ range $headings }}
+  {{ $title := replaceRE "^##\\s" "" . }}
+  <li><a href="{{ absURL (print $productName "/changelog/#" (urlize $title)) }}">{{ $title }}</a></li>
+  {{ end }}  
+  <li><a href="{{ absURL (print $productName "/changelog/")}}">Older...</a></li>
+  {{ else }}
+  <li><p>No changelog found...</p></li>
+  {{ end }}
+</ul>

layouts/partials/changelog-date.html

@@ -21,6 +21,7 @@
       <atomic-layout-section section="facets">
         <atomic-facet field="f5_product" label="Show by product"></atomic-facet>
         <atomic-facet field="language" label="Show by language"></atomic-facet>
+        <atomic-facet field="f5_document_type" label="Show by type"></atomic-facet>
       </atomic-layout-section>
 
       <!-- Main Section -->

layouts/partials/coveo-atomic.html

@@ -1,9 +1,10 @@
 {{- $type := .Get 0 | default (.Get "type") | default "" -}}
 {{- $title := .Get 1 | default (.Get "title") | default "" -}}
 {{ partial "callout.html" (dict
-    "class" $type
+    "class" (printf "%s %s" $type "call-out")
     "title" $title
     "icon"  "fa-solid fa-triangle-exclamation"
-    "inline" true
+    "sideline" true
+    "type" ($type | strings.FirstUpper)
     "content" .Inner
 ) }}

layouts/shortcodes/banner.html

@@ -2,7 +2,7 @@
  "class" "tip"
  "title" "Before you begin:"
  "icon"  ""
- "inline" "false"
+ "sideline" "false"
  "content" .Inner
 ) }}
 {{ warnf "'<before-you-begin></before-you-begin>' is being deprecated. Use generic 'call-out' shortcode instead."}}