From c516295bb8f6d72312eae4a67d14e904ec1fa4f2 Mon Sep 17 00:00:00 2001 From: Pascal Breuer Date: Mon, 11 May 2020 17:51:10 +0200 Subject: Add config option to disable incident history --- exampleSite/config.yml | 6 ++++ layouts/index.html | 22 +++++++------- layouts/index.xml | 62 +++++++++++++++++++++------------------- layouts/partials/footer.html | 34 +++++++++++----------- layouts/partials/index/tabs.html | 10 ++++--- static/admin/config.yml | 6 ++++ 6 files changed, 80 insertions(+), 60 deletions(-) diff --git a/exampleSite/config.yml b/exampleSite/config.yml index afb644b..6ebd147 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -172,6 +172,12 @@ params: # STRING; `monthly`, `yearly`, `none` incidentHistoryFormat: "yearly" + # Should incident history be enabled? + # + # Default: `true` + # BOOLEAN; `true`, `false` + enableHistory: true + # Disable dark mode # # If your OS and browser support the diff --git a/layouts/index.html b/layouts/index.html index c02224a..cb1c759 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -37,16 +37,18 @@ {{ partial "index/tabs" . }} -
- {{ 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 }} -
-
+ {{ if .Site.Params.enableHistory }} +
+ {{ 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 }} +
+
+ {{ end }} {{ partial "js" . }} {{ partial "footer" . }} diff --git a/layouts/index.xml b/layouts/index.xml index e9ae53d..c0a9cf5 100644 --- a/layouts/index.xml +++ b/layouts/index.xml @@ -1,30 +1,32 @@ - - - - {{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }} - {{ .Permalink }} - {{ T "incidentHistory" }} - github.com/cstate - {{ with .Site.LanguageCode }}{{.}}{{end}} - {{ if not .Date.IsZero }} - {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }} - {{ end }} - {{ with .Site.Copyright }} - {{.}}{{end}} - {{ with .OutputFormats.Get "RSS" }} - {{ printf "" .Permalink .MediaType | safeHTML }} - {{ end }} - {{ $incidents := where .Site.RegularPages "Params.section" "issue" }} - {{ range $incidents }} - - {{ if .Params.resolved }}[{{ T "resolved" }}] {{ end }}{{ .Title }} - {{ .Permalink }} - {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }} - {{ .Permalink }} - {{ .Params.resolvedWhen }} - {{ .Content | html }} - - {{ end }} - - +{{ if .Site.Params.enableHistory }} + + + + {{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }} + {{ .Permalink }} + {{ T "incidentHistory" }} + github.com/cstate + {{ with .Site.LanguageCode }}{{.}}{{end}} + {{ if not .Date.IsZero }} + {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }} + {{ end }} + {{ with .Site.Copyright }} + {{.}}{{end}} + {{ with .OutputFormats.Get "RSS" }} + {{ printf "" .Permalink .MediaType | safeHTML }} + {{ end }} + {{ $incidents := where .Site.RegularPages "Params.section" "issue" }} + {{ range $incidents }} + + {{ if .Params.resolved }}[{{ T "resolved" }}] {{ end }}{{ .Title }} + {{ .Permalink }} + {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }} + {{ .Permalink }} + {{ .Params.resolvedWhen }} + {{ .Content | html }} + + {{ end }} + + +{{ end }} \ No newline at end of file diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 5faf5c6..1be7f97 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -13,22 +13,24 @@ {{ T "poweredBy" }} cState -
- -

- - ⚡ - {{ T "rss" }} — - {{ with $.Site.Home.OutputFormats.Get "rss" }} - {{ T "toAllUpdates" }} - {{ end }} - {{ if not .IsHome }} - {{ with .OutputFormats.Get "rss" }} - {{ T "or" }} {{ T "onlyThisFeed" }} ({{ $.Title }}) - {{ end }} - {{ end }} - -

+ {{ if .Site.Params.enableHistory }} +
+ +

+ + ⚡ + {{ T "rss" }} — + {{ with $.Site.Home.OutputFormats.Get "rss" }} + {{ T "toAllUpdates" }} + {{ end }} + {{ if not .IsHome }} + {{ with .OutputFormats.Get "rss" }} + {{ T "or" }} {{ T "onlyThisFeed" }} ({{ $.Title }}) + {{ end }} + {{ end }} + +

+ {{ end }} diff --git a/layouts/partials/index/tabs.html b/layouts/partials/index/tabs.html index e1fc986..015eb36 100644 --- a/layouts/partials/index/tabs.html +++ b/layouts/partials/index/tabs.html @@ -13,8 +13,10 @@ {{ else }} -
-

{{ T "incidentHistory" }}

-
-
+ {{ if .Site.Params.enableHistory }} +
+

{{ T "incidentHistory" }}

+
+
+ {{ end }} {{ end }} \ No newline at end of file diff --git a/static/admin/config.yml b/static/admin/config.yml index 98a6059..2d35ab3 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 enabled?' + name: 'incidentHistoryFormat' + hint: 'This also disables the RSS feed.' + widget: 'boolean' + default: true # Incidents view format - label: 'Should the incident history be sorted by year or month?' name: 'incidentHistoryFormat' -- cgit v1.2.3-70-g09d2 From ff4731c733fc7ac5ca164670ee851532074e8b7c Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Mon, 18 May 2020 20:28:17 +0300 Subject: fix value --- static/admin/config.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/static/admin/config.yml b/static/admin/config.yml index 2d35ab3..c1c3507 100644 --- a/static/admin/config.yml +++ b/static/admin/config.yml @@ -194,9 +194,9 @@ collections: max: 100 default: 10 # Incidents history - - label: 'Should the incident history be enabled?' - name: 'incidentHistoryFormat' - hint: 'This also disables the RSS feed.' + - label: 'Should the incident history be shown?' + name: 'enableIncidentHistory' + hint: 'By disabling the incident history, you also disabl the RSS feed. To ensure no incidents are shown, you should delete them after they are resolved. This ootion overrides any other options that tailor your incident history’s look.' widget: 'boolean' default: true # Incidents view format -- cgit v1.2.3-70-g09d2 From 85dd7a86eaa39f9eb516b6fac1713b90bd8267b8 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Mon, 18 May 2020 20:31:55 +0300 Subject: Add explanation to config.yml --- exampleSite/config.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/exampleSite/config.yml b/exampleSite/config.yml index 6ebd147..5e04766 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -174,9 +174,15 @@ params: # Should incident history be enabled? # + # 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: `true` # BOOLEAN; `true`, `false` - enableHistory: true + enableIncidentHistory: true # Disable dark mode # @@ -328,4 +334,4 @@ outputs: outputFormats: svg: isPlainText: true - mediaType: image/svg+xml \ No newline at end of file + mediaType: image/svg+xml -- cgit v1.2.3-70-g09d2 From 7db76cc6fd2f19c2d48f33ce2d010e1d2d67ef2a Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Mon, 18 May 2020 20:33:15 +0300 Subject: Typos --- static/admin/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/admin/config.yml b/static/admin/config.yml index c1c3507..0eb6f48 100644 --- a/static/admin/config.yml +++ b/static/admin/config.yml @@ -196,7 +196,7 @@ collections: # Incidents history - label: 'Should the incident history be shown?' name: 'enableIncidentHistory' - hint: 'By disabling the incident history, you also disabl the RSS feed. To ensure no incidents are shown, you should delete them after they are resolved. This ootion overrides any other options that tailor your incident history’s look.' + 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: true # Incidents view format -- cgit v1.2.3-70-g09d2 From 75b462973ee153b3a461700b12870c7add9f78bd Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Tue, 19 May 2020 11:55:35 +0300 Subject: Update footer.html --- layouts/partials/footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 1be7f97..fb1bb50 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -13,7 +13,7 @@ {{ T "poweredBy" }} cState - {{ if .Site.Params.enableHistory }} + {{ if not .Site.Params.disableIncidentHistory }}

-- cgit v1.2.3-70-g09d2 From 56d9f7ada5016f62f35a1a20609f0881f4f11ed6 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Tue, 19 May 2020 11:55:48 +0300 Subject: Update tabs.html --- layouts/partials/index/tabs.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/layouts/partials/index/tabs.html b/layouts/partials/index/tabs.html index 015eb36..9544890 100644 --- a/layouts/partials/index/tabs.html +++ b/layouts/partials/index/tabs.html @@ -13,10 +13,10 @@ {{ else }} - {{ if .Site.Params.enableHistory }} + {{ if not .Site.Params.disableIncidentHistory }}

{{ T "incidentHistory" }}

{{ end }} -{{ end }} \ No newline at end of file +{{ end }} -- cgit v1.2.3-70-g09d2 From 5d1fd9751d867127f3f23f7313825a8e1e92d7f0 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Tue, 19 May 2020 11:56:47 +0300 Subject: Update config.yml --- exampleSite/config.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/exampleSite/config.yml b/exampleSite/config.yml index 5e04766..397eac8 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -172,7 +172,7 @@ params: # STRING; `monthly`, `yearly`, `none` incidentHistoryFormat: "yearly" - # Should incident history be enabled? + # Should incident history be hidden? # # By disabling the incident history, you also disable # the RSS feed. To ensure no incidents are shown, you @@ -180,9 +180,9 @@ params: # overrides any other options that tailor your incident # history’s look. # - # Default: `true` + # Default: `false` # BOOLEAN; `true`, `false` - enableIncidentHistory: true + disableIncidentHistory: false # Disable dark mode # -- cgit v1.2.3-70-g09d2 From 44f1a08801ba8acf655071637ad7aa9a67981403 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Tue, 19 May 2020 11:58:00 +0300 Subject: Update index.html --- layouts/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/index.html b/layouts/index.html index cb1c759..2faafaa 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -37,7 +37,7 @@ {{ partial "index/tabs" . }} - {{ if .Site.Params.enableHistory }} + {{ if not .Site.Params.disableIncidentHistory }}
{{ if eq .Site.Params.incidentHistoryFormat "yearly" }} {{ partial "index/incidents-yearly" . }} -- cgit v1.2.3-70-g09d2 From 55e85c9249159184a752078cc33b796e0a2c007e Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Tue, 19 May 2020 11:58:22 +0300 Subject: Update index.xml --- layouts/index.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/layouts/index.xml b/layouts/index.xml index c0a9cf5..c8bce41 100644 --- a/layouts/index.xml +++ b/layouts/index.xml @@ -1,4 +1,4 @@ -{{ if .Site.Params.enableHistory }} +{{ if not .Site.Params.disableIncidentHistory }}