Merge pull request kubernetes#47411 from sftim/20240808_docsy_friendl…

…y_deprecation_warnings Revise deprecation warnings to be more Docsy friendly
dipesh-rawat · Aug 29, 2024 · fd98767 · fd98767
2 parents 98861dd + 3346b60
commit fd98767
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 9 deletions.
diff --git a/layouts/blog/baseof.html b/layouts/blog/baseof.html
@@ -32,9 +32,6 @@
           <main class="col-12 col-md-9 col-xl-8 pl-md-5 pr-md-4" role="main"
               {{ if .IsPage }}data-pagefind-body data-pagefind-meta="date:{{  $.Date.Format "2006-01-02" }}"{{ end }}
             ><!-- inside main element -->
-            {{ block "deprecated" . }}
-              {{ partial "deprecation-warning.html" . }}
-            {{ end }}
             {{ with .CurrentSection.OutputFormats.Get "rss" -}}
             <a class="btn btn-lg -bg-orange td-rss-button d-none d-lg-block" href="{{ .Permalink | safeURL }}" target="_blank">
               RSS <i class="fa fa-rss ml-2 "></i>

diff --git a/layouts/blog/list.html b/layouts/blog/list.html
@@ -12,6 +12,7 @@
 {{ $pageGroups := $pag.PageGroups}}
 {{ if eq $pag.PageNumber 1 }}
 {{ end }}
+{{ partial "deprecation-warning.html" . }}
 <div class="row">
 	<div class="col-12">
 		{{ range $pageGroups }}

diff --git a/layouts/blog/single.html b/layouts/blog/single.html
@@ -0,0 +1,4 @@
+{{ define "main" }}
+{{ partial "deprecation-warning.html" . }}
+{{ .Render "content" }}
+{{ end }}
diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html
@@ -24,9 +24,6 @@
           <!--main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main"-->
           <main role="main" class="col-xl-8" {{ if ne .Params.cid "docsHome" }}data-pagefind-body{{ end }}{{ if (and .IsPage .Params.description ) }} data-pagefind-meta="description:{{ .Params.description }}"{{ end }}>
               {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }}
-              {{ block "deprecated" . }}
-                {{ partial "deprecation-warning.html" . }}
-              {{ end }}
               {{ block "outdated_content" . }}
                 {{ partial "docs/outdated_content.html" . }}
               {{ end }}

diff --git a/layouts/docs/glossary.html b/layouts/docs/glossary.html
@@ -3,6 +3,7 @@
 {{ end }}
 
 {{ define "main" }}
+{{ partial "deprecation-warning.html" . }}
 <h1>{{ .Title }}</h1>
 {{- with resources.Get "css/glossary.css" -}}
 <link href="{{ .RelPermalink }}" rel="stylesheet">

diff --git a/layouts/docs/list.html b/layouts/docs/list.html
@@ -6,6 +6,7 @@
 {{- end -}}
 {{- end -}}
     <div class="td-content">
+        {{- partial "deprecation-warning.html" . -}}
         {{ $hasContent := false }}
         {{ with .File }}
             {{ if ne .Filename "" }}

diff --git a/layouts/docs/release-info.html b/layouts/docs/release-info.html
@@ -2,6 +2,7 @@
 {{ if not .Site.Params.deprecated }}
   {{ .Content }}
 {{ else }}
+{{ partial "deprecation-warning.html" . }}
 <div class="section-index">
   {{ range where .Site.Pages "Section" "releases" }}
     {{ if not .IsNode }}
@@ -10,6 +11,6 @@ <h5><a href="{{ .RelPermalink }}">{{ .Title }}</a></h5>
       </div>
     {{ end }}
   {{ end }}
-</div>    
+</div>
 {{ end }}
 {{ end }}
diff --git a/layouts/docs/single.html b/layouts/docs/single.html
@@ -1,4 +1,5 @@
 {{ define "main" }}
+{{ partial "deprecation-warning.html" . }}
     <div class="td-content">
     {{- if .HasShortcode "kat-button" -}}
     <div class="pageinfo pageinfo-secondary">

diff --git a/layouts/partials/deprecation-warning.html b/layouts/partials/deprecation-warning.html
@@ -1,6 +1,6 @@
 {{ if (.Site.Param "deprecated") }}
 <section id="deprecation-warning">
-  <div class="content deprecation-warning pageinfo">
+  <div class="deprecation-warning {{ if $.IsHome }}home-pageinfo{{else}}pageinfo{{ end }}">
     <h3>
       {{ T "deprecation_title" }} {{ .Param "version" }}
     </h3>
@@ -11,7 +11,7 @@ <h3>
 </section>
 {{ else if and (eq .Section "blog") (not .Params.evergreen) .Date (.Date.Before (now.AddDate -1 0 0)) -}}
 <section id="deprecation-warning">
-  <div class="content deprecation-warning pageinfo outdated-blog">
+  <div class="deprecation-warning pageinfo outdated-blog">
     <p>{{ T "outdated_blog__message" }}</p>
   </div>
 </section>