Skip to content

Commit

Permalink
Add announcement shortcode and partial
Browse files Browse the repository at this point in the history
Add shortcode, partial, and css so we can display an accouncement
site-wide.
Create a shortcode for use in content/en/ _index.html so
announcement is displayed on website landing page.
Create a partial for use in layouts/docs/baseof.html so
announcement is displaye on every page in '<url>/docs/home'
directory.
Add two values to config.toml: announcement (boolean) for toggling
display of announcement; announcement_message, which is the actual
message.

Signed-off-by: Aimee Ukasick <[email protected]>
  • Loading branch information
aimeeu committed Sep 9, 2019
1 parent 2418bdb commit 79a961b
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 1 deletion.
5 changes: 5 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ nextUrl = "https://kubernetes-io-vnext-staging.netlify.com/"
githubWebsiteRepo = "github.com/kubernetes/website"
githubWebsiteRaw = "raw.githubusercontent.com/kubernetes/website"

# param for displaying an announcement block on every page; see PR #16210
announcement = false
# announcement_message is only displayed when announcement = true; update with your specific message
announcement_message = "The Kubernetes Documentation team would like your feedback! Please take a <a href='https://www.surveymonkey.com/r/8R237FN' target='_blank'>short survey</a> so we can improve the Kubernetes online documentation."

[[params.versions]]
fullversion = "v1.15.0"
version = "v1.15"
Expand Down
1 change: 1 addition & 0 deletions content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
abstract: "Automated container deployment, scaling, and management"
cid: home
---
{{< announcement >}}

{{< deprecationwarning >}}

Expand Down
3 changes: 2 additions & 1 deletion layouts/docs/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@
{{ partial "docs/top-menu.html" . }}
</section>
{{ end }}
{{ block "announcement" . }}{{ partial "announcement.html" . }}{{ end }}
{{ block "deprecation" . }}{{ partial "deprecation-warning.html" . }}{{ end }}
<section id="encyclopedia">
{{ block "side-menu" . }}<div id="docsToc" style="display:none;"></div>{{ end }}
<div id="{{ block "content-id" . }}docsContent{{ end }}">
{{ block "content" . }}{{ end }}

{{ partial "feedback.html" . }}

{{ partial "git-info.html" . }}
Expand Down
11 changes: 11 additions & 0 deletions layouts/partials/announcement.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{{ if .Param "announcement"}}
<section id="announcement">
<main>
<div class="content announcement">
<h3>
{{ .Param "announcement_message" | markdownify }}
</h3>
</div>
</main>
</section>
{{ end }}
11 changes: 11 additions & 0 deletions layouts/shortcodes/announcement.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{{ if .Page.Param "announcement" }}
<section id="announcement">
<main>
<div class="content announcement">
<h3>
{{ .Page.Param "announcement_message" | markdownify }}
</h3>
</div>
</main>
</section>
{{ end }}
6 changes: 6 additions & 0 deletions static/css/announcement.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.announcement {
padding: 20px;
margin: 20px 0;
border-radius: 3px;
background-color: #eeeeee;
}

0 comments on commit 79a961b

Please sign in to comment.