Add config option to disable incident history #108

6 files changed, 88 insertions, 62 deletions

diff --git a/exampleSite/config.yml b/exampleSite/config.yml
index afb644b..397eac8 100644
--- a/exampleSite/config.yml
+++ b/exampleSite/config.yml
@@ -172,6 +172,18 @@ params:
   # STRING; `monthly`, `yearly`, `none`
   incidentHistoryFormat: "yearly"
 
+  # Should incident history be hidden?
+  #
+  # By disabling the incident history, you also disable
+  # the RSS feed. To ensure no incidents are shown, you
+  # should delete them after they are resolved. This option
+  # overrides any other options that tailor your incident
+  # history’s look.
+  #
+  # Default: `false`
+  # BOOLEAN; `true`, `false`
+  disableIncidentHistory: false
+
   # Disable dark mode
   #
   # If your OS and browser support the
@@ -322,4 +334,4 @@ outputs:
 outputFormats:
   svg:
     isPlainText: true
-    mediaType: image/svg+xml
\ No newline at end of file
+    mediaType: image/svg+xml
diff --git a/layouts/index.html b/layouts/index.html
index c02224a..2faafaa 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -37,16 +37,18 @@
   {{ partial "index/tabs" . }}
 
   <!-- All incidents + pagination -->
-  <div class="contain contain--more" id="incidents">
-    {{ if eq .Site.Params.incidentHistoryFormat "yearly" }}
-      {{ partial "index/incidents-yearly" . }}
-    {{ else if eq .Site.Params.incidentHistoryFormat "monthly" }}
-      {{ partial "index/incidents-monthly" . }}
-    {{ else }}
-      {{ partial "index/incidents" . }}
-    {{ end }}
-    <div class="padding"></div>
-  </div>
+  {{ if not .Site.Params.disableIncidentHistory }}
+    <div class="contain contain--more" id="incidents">
+      {{ if eq .Site.Params.incidentHistoryFormat "yearly" }}
+        {{ partial "index/incidents-yearly" . }}
+      {{ else if eq .Site.Params.incidentHistoryFormat "monthly" }}
+        {{ partial "index/incidents-monthly" . }}
+      {{ else }}
+        {{ partial "index/incidents" . }}
+      {{ end }}
+      <div class="padding"></div>
+    </div>
+  {{ end }}
 
   {{ partial "js" . }}
   {{ partial "footer" . }}
diff --git a/layouts/index.xml b/layouts/index.xml
index e9ae53d..c8bce41 100644
--- a/layouts/index.xml
+++ b/layouts/index.xml
@@ -1,30 +1,32 @@
-<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
-  <channel>
-    <!--
-    <link rel="alternate" type="text/html" href="{{ .Site.BaseURL }}"/> -->
-    <title>{{ if eq  .Title  .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title>
-    <link>{{ .Permalink }}</link>
-    <description>{{ T "incidentHistory" }}</description>
-    <generator>github.com/cstate</generator>
-    {{ with .Site.LanguageCode }}<language>{{.}}</language>{{end}}
-    {{ if not .Date.IsZero }}
-    <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>
-    {{ end }}
-    {{ with .Site.Copyright }}
-    <copyright>{{.}}</copyright>{{end}}
-    {{ with .OutputFormats.Get "RSS" }}
-      {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
-    {{ end }}
-    {{ $incidents := where .Site.RegularPages "Params.section" "issue" }}
-    {{ range $incidents }}
-      <item>
-        <title>{{ if .Params.resolved }}[{{ T "resolved" }}] {{ end }}{{ .Title }}</title>
-        <link>{{ .Permalink }}</link>
-        <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
-        <guid>{{ .Permalink }}</guid>
-        <category>{{ .Params.resolvedWhen }}</category>
-        <description>{{ .Content | html }}</description>
-      </item>
-    {{ end }}
-  </channel>
-</rss>
+{{ if not .Site.Params.disableIncidentHistory }}
+  <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+    <channel>
+      <!--
+      <link rel="alternate" type="text/html" href="{{ .Site.BaseURL }}"/> -->
+      <title>{{ if eq  .Title  .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title>
+      <link>{{ .Permalink }}</link>
+      <description>{{ T "incidentHistory" }}</description>
+      <generator>github.com/cstate</generator>
+      {{ with .Site.LanguageCode }}<language>{{.}}</language>{{end}}
+      {{ if not .Date.IsZero }}
+      <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>
+      {{ end }}
+      {{ with .Site.Copyright }}
+      <copyright>{{.}}</copyright>{{end}}
+      {{ with .OutputFormats.Get "RSS" }}
+        {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
+      {{ end }}
+      {{ $incidents := where .Site.RegularPages "Params.section" "issue" }}
+      {{ range $incidents }}
+        <item>
+          <title>{{ if .Params.resolved }}[{{ T "resolved" }}] {{ end }}{{ .Title }}</title>
+          <link>{{ .Permalink }}</link>
+          <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
+          <guid>{{ .Permalink }}</guid>
+          <category>{{ .Params.resolvedWhen }}</category>
+          <description>{{ .Content | html }}</description>
+        </item>
+      {{ end }}
+    </channel>
+  </rss>
+{{ end }}
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
index 5faf5c6..fb1bb50 100644
--- a/layouts/partials/footer.html
+++ b/layouts/partials/footer.html
@@ -13,22 +13,24 @@
     <!-- Please keep this one around to help cState grow <3 -->
     <small class="footer__copyright faded">{{ T "poweredBy" }} <a href="https://github.com/cstate/cstate"><b>cState</b></a></small>
 
-    <hr>
-
-    <p class="hinted">
-      <small>
-        ⚡
-        {{ T "rss" }} —
-        {{ with $.Site.Home.OutputFormats.Get "rss" }}
-          <a href="{{ .Permalink }}" class="no-underline">{{ T "toAllUpdates" }}</a>
-        {{ end }}
-        {{ if not .IsHome }}
-        {{ with .OutputFormats.Get "rss" }}
-          {{ T "or" }} <a href="{{ .Permalink }}" class="no-underline">{{ T "onlyThisFeed" }} ({{ $.Title }})</a>
-        {{ end }}
-        {{ end }}
-      </small>
-    </p>
+    {{ if not .Site.Params.disableIncidentHistory }}
+      <hr>
+      
+      <p class="hinted">
+        <small>
+          ⚡
+          {{ T "rss" }} —
+          {{ with $.Site.Home.OutputFormats.Get "rss" }}
+            <a href="{{ .Permalink }}" class="no-underline">{{ T "toAllUpdates" }}</a>
+          {{ end }}
+          {{ if not .IsHome }}
+          {{ with .OutputFormats.Get "rss" }}
+            {{ T "or" }} <a href="{{ .Permalink }}" class="no-underline">{{ T "onlyThisFeed" }} ({{ $.Title }})</a>
+          {{ end }}
+          {{ end }}
+        </small>
+      </p>
+    {{ end }}
   </div>
 </div>
 
diff --git a/layouts/partials/index/tabs.html b/layouts/partials/index/tabs.html
index e1fc986..9544890 100644
--- a/layouts/partials/index/tabs.html
+++ b/layouts/partials/index/tabs.html
@@ -13,8 +13,10 @@
     </div>
   </div>
 {{ else }}
-  <div class="contain contain--more">
-    <h2 class="center">{{ T "incidentHistory" }}</h2>
-    <hr class="clean">
-  </div>
-{{ end }}
\ No newline at end of file
+  {{ if not .Site.Params.disableIncidentHistory }}
+    <div class="contain contain--more">
+      <h2 class="center">{{ T "incidentHistory" }}</h2>
+      <hr class="clean">
+    </div>
+  {{ end }}
+{{ end }}
diff --git a/static/admin/config.yml b/static/admin/config.yml
index 2ab0db9..8271a93 100644
--- a/static/admin/config.yml
+++ b/static/admin/config.yml
@@ -193,6 +193,12 @@ collections:
                 min: 1
                 max: 100
                 default: 10
+              # Incidents history
+              - label: 'Should the incident history be hidden?'
+                name: 'disableIncidentHistory'
+                hint: 'By disabling the incident history, you also disable the RSS feed. To ensure no incidents are shown, you should delete them after they are resolved. This option overrides any other options that tailor your incident history’s look.'
+                widget: 'boolean'
+                default: false
               # Incidents view format
               - label: 'Should the incident history be sorted by year or month?'
                 name: 'incidentHistoryFormat'