- {{ $systems := .Site.Params.systems }} - {{ range $systems }} - {{ $activeComponentIssues := where $active "Params.affected" "intersect" (slice .name) }} - - {{ $thisIsNotice := where $activeComponentIssues "Params.severity" "=" "notice" }} - {{ $thisIsDisrupted := where $activeComponentIssues "Params.severity" "=" "disrupted" }} - {{ $thisIsDown := where $activeComponentIssues "Params.severity" "=" "down" }} - -

- - {{ .name }} - - - {{ with .description }} - - (?) - - - {{ . }} - + +

+ {{ $systems := .Site.Params.systems }} + {{ $categories := .Site.Params.categories }} + + {{ range $categories }} +

+ {{ if not .untitled }} +

+ {{ if .closed }}⯈{{ else }}⯆{{ end }} + + {{ .name }} + + {{ with .description }} + + (?) + + + {{ . }} - {{ end }} - - - {{ if $thisIsDown }} - {{ T "thisIsDown" }} - {{ else }} - {{ if $thisIsDisrupted }} - {{ T "thisIsDisrupted" }} - {{ else }} - {{ if $thisIsNotice }} - {{ T "thisIsNotice" }} - {{ else }} - {{ T "thisIsOk" }} - {{ end }}{{ end }}{{ end }} + {{ end }} + +

+ {{ else }} +

+ {{ end }} + + {{ $categorySystems := where $systems "category" "=" .name }} + +

+ {{ range $categorySystems }} + {{ $activeComponentIssues := where $active "Params.affected" "intersect" (slice .name) }} - {{ with .partial }} -

- {{ partial . . }} + {{ $thisIsNotice := where $activeComponentIssues "Params.severity" "=" "notice" }} + {{ $thisIsDisrupted := where $activeComponentIssues "Params.severity" "=" "disrupted" }} + {{ $thisIsDown := where $activeComponentIssues "Params.severity" "=" "down" }} + +

+ + {{ .name }} + + + {{ with .description }} + + (?) + + + {{ . }} + + + {{ end }} + + + {{ if $thisIsDown }} + {{ T "thisIsDown" }} + {{ else }} + {{ if $thisIsDisrupted }} + {{ T "thisIsDisrupted" }} + {{ else }} + {{ if $thisIsNotice }} + {{ T "thisIsNotice" }} + {{ else }} + {{ T "thisIsOk" }} + {{ end }}{{ end }}{{ end }} + + + {{ with .partial }} +

+ {{ partial . . }} +

+ {{ end }}

- {{ end }} + {{ end }}

- {{ end }} -

\ No newline at end of file +

+ {{ end }} + +

\ No newline at end of file diff --git a/layouts/partials/meta.html b/layouts/partials/meta.html index 6a6f790..ad4655a 100644 --- a/layouts/partials/meta.html +++ b/layouts/partials/meta.html @@ -27,7 +27,7 @@ margin: 0; background: #fff; color: #4d4d4d; - font: 100%/1.5 BlinkMacSystemFont, -apple-system, "San Francisco Text", "Roboto", "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + font: 100%/1.5 'Inter UI', BlinkMacSystemFont, -apple-system, "San Francisco Text", "Roboto", "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; box-sizing: border-box; -webkit-tap-highlight-color: rgba(0,0,0, 0.25); } @@ -64,7 +64,8 @@ h1, h2, h4 { font-weight: normal; color: #000; - font-family: "Segoe UI", BlinkMacSystemFont, -apple-system, "San Francisco Text", "Roboto", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + font-family: 'Inter UI', "Segoe UI", BlinkMacSystemFont, -apple-system, "San Francisco Text", "Roboto", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + letter-spacing: -1px; } h3 { -- cgit v1.2.3-70-g09d2 From f286452fa4abbd2782af050221ed59386945a3c1 Mon Sep 17 00:00:00 2001 From: Mantas <11616378+mistermantas@users.noreply.github.com> Date: Wed, 8 May 2019 08:58:15 +0300 Subject: add donation info --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index bea307f..1e05c13 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ + [Updating](#updating-) + [FAQ](#faq-) + [Contribute](#contribute-) +* [Donate](#donate-) + [License](#license-) *** @@ -170,6 +171,15 @@ Time to break that down. Check out [the wiki](https://github.com/cstate/cstate/wiki). +## Donate ❤️ + +cState is only a hobby project of @mistermantas, but it’s a prideful one. + +Support the developer and ensure the future of the project by donating for a cuppa tea, some ice cream, or if you are feeling generous — a large size pizza. + +* [PayPal](https://paypal.me/AlbinaV} +* or you can make a bank transfer. For info, [get in touch](https://mnts.lt) + ## Contribute 💥 > Want to become a maintainer? Hit me up! [@mistermantas](https://twitter.com/mistermantas) -- cgit v1.2.3-70-g09d2 From f8b0da97d84c043576418b9d28f5d75d94d611aa Mon Sep 17 00:00:00 2001 From: Mantas <11616378+mistermantas@users.noreply.github.com> Date: Wed, 8 May 2019 22:16:24 +0300 Subject: Categories working except for the arrow --- exampleSite/config.yml | 6 +++++- layouts/partials/index/components.html | 8 +++++--- layouts/partials/index/summary.html | 2 +- layouts/partials/meta.html | 26 +++++++++++++++++++------- 4 files changed, 30 insertions(+), 12 deletions(-) diff --git a/exampleSite/config.yml b/exampleSite/config.yml index 8b45b9b..a45d06d 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -109,6 +109,8 @@ params: systems: - name: Gateway category: North Coast + - name: Backup Gateway + category: East Coast - name: API description: The guts of the application. category: Uncategorized @@ -119,10 +121,12 @@ params: categories: - name: North Coast description: The worst one. Or the best one. - closed: true + closed: true + - name: East Coast - name: Uncategorized untitled: true + # What date format to use? # diff --git a/layouts/partials/index/components.html b/layouts/partials/index/components.html index 392acb7..47da96c 100644 --- a/layouts/partials/index/components.html +++ b/layouts/partials/index/components.html @@ -13,8 +13,10 @@ {{ range $categories }}

{{ if not .untitled }} -

- {{ if .closed }}⯈{{ else }}⯆{{ end }} +

+ + {{ if .closed }}⯈{{ else }}⯆{{ end }} + {{ .name }} @@ -35,7 +37,7 @@ {{ $categorySystems := where $systems "category" "=" .name }} -

{{ range $categorySystems }} {{ $activeComponentIssues := where $active "Params.affected" "intersect" (slice .name) }} diff --git a/layouts/partials/index/summary.html b/layouts/partials/index/summary.html index d8e3108..de6bceb 100644 --- a/layouts/partials/index/summary.html +++ b/layouts/partials/index/summary.html @@ -20,5 +20,5 @@ {{ end }}{{ end }}{{ end }} - +

\ No newline at end of file diff --git a/layouts/partials/meta.html b/layouts/partials/meta.html index ad4655a..9acc554 100644 --- a/layouts/partials/meta.html +++ b/layouts/partials/meta.html @@ -20,6 +20,8 @@ var themeNoticeColor = '#{{ .Site.Params.notice }}'; var themeDisruptedColor = '#{{ .Site.Params.disrupted }}'; var themeDownColor = '#{{ .Site.Params.down }}'; + + {{ if .Site.Params.enableCustomHTML }} {{ partial "custom/meta" . }} -- cgit v1.2.3-70-g09d2 From c1c0828f179fb9d6809fd44613de66c98e8882e9 Mon Sep 17 00:00:00 2001 From: Alfhir <46976891+Alfhir@users.noreply.github.com> Date: Sun, 27 Oct 2019 15:19:44 +0100 Subject: Update de.yaml Fix typo --- i18n/de.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/de.yaml b/i18n/de.yaml index 004c65b..15a6153 100644 --- a/i18n/de.yaml +++ b/i18n/de.yaml @@ -86,7 +86,7 @@ translation: Ungelöst! - id: calmBeforeTheStorm - translation: Is dies die Ruhe vor dem Sturm? + translation: Ist dies die Ruhe vor dem Sturm? - id: noIncidentsDesc translation: Es liegen keine Vorfälle vor. Eventuell hat der Besitzer (oder die Besitzer) noch keine Vorfälle verzeichnet. -- cgit v1.2.3-70-g09d2 From 87a3e08685f778be507f6c835dc4e815b2bba964 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas <11616378+mistermantas@users.noreply.github.com> Date: Sun, 27 Oct 2019 17:50:13 +0200 Subject: #86 --- images/highlight.png | Bin 72664 -> 74273 bytes images/highlight.svg | 35 +++++++++++++++++------------------ 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/images/highlight.png b/images/highlight.png index a16c9ef..fcdb299 100644 Binary files a/images/highlight.png and b/images/highlight.png differ diff --git a/images/highlight.svg b/images/highlight.svg index 7877c74..abed901 100644 --- a/images/highlight.svg +++ b/images/highlight.svg @@ -3,24 +3,21 @@ - - - - + + + - - + + - - + + - - - + @@ -134,15 +131,17 @@ - - - + + + - + - - - + + + + + -- cgit v1.2.3-70-g09d2 From 91f464f8f67e172f7276b3644e16b3b89a992113 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sun, 15 Dec 2019 12:12:43 +0200 Subject: Design updates - dark mode finished, mini fixes --- README.md | 2 +- exampleSite/config.yml | 15 ++++ .../issues/2019-10-04-testing-cstate-functions.md | 1 - layouts/issues/issue.html | 6 +- layouts/issues/small.html | 6 +- layouts/partials/meta.html | 82 +++++++++++++++------- 6 files changed, 80 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 809feca..5a047c5 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ git submodule add https://github.com/cstate/cstate 1. Clone this repository in the command line: ```bash -git clone --recurisve https://github.com/cstate/cstate.git +git clone --recursive -b master https://github.com/cstate/cstate.git ``` 2. Navigate to the theme directory: diff --git a/exampleSite/config.yml b/exampleSite/config.yml index a894d26..98f95c0 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -172,6 +172,21 @@ params: # STRING; `monthly`, `yearly`, `none` incidentHistoryFormat: "yearly" + # Disable dark mode + # + # If your OS and browser support the + # `prefers-color-scheme` media query, + # cState will automatically switch to + # a darker user interface. + # + # cState uses its built-in colors for + # most of the interface to ensure + # a good user experience. + # + # Default: false + # BOOLEAN; `true`, `false` + disableDarkMode: false + # Should we show the logo or the title # of the status page? # diff --git a/exampleSite/content/issues/2019-10-04-testing-cstate-functions.md b/exampleSite/content/issues/2019-10-04-testing-cstate-functions.md index e8e2250..efdf7d7 100644 --- a/exampleSite/content/issues/2019-10-04-testing-cstate-functions.md +++ b/exampleSite/content/issues/2019-10-04-testing-cstate-functions.md @@ -1,7 +1,6 @@ --- title: Testing New cState Features date: 2019-10-04 18:05:00 -resolvedWhen: 2019-10-04 18:05:00 informational: true section: issue --- diff --git a/layouts/issues/issue.html b/layouts/issues/issue.html index 24cadd8..62f3ab3 100644 --- a/layouts/issues/issue.html +++ b/layouts/issues/issue.html @@ -82,11 +82,11 @@ {{ else }} {{ if eq .Params.severity "down" }} - ◼ + ■ {{ else if eq .Params.severity "disrupted" }} - ▲ + ▲ {{ else }} - ◆ + ◆ {{ end }} {{ T "downtimeOngoing" }} {{ end }} diff --git a/layouts/issues/small.html b/layouts/issues/small.html index 9349046..0e1d5ed 100644 --- a/layouts/issues/small.html +++ b/layouts/issues/small.html @@ -82,11 +82,11 @@ {{ if eq .Params.severity "down" }} - ◼ + ■ {{ else if eq .Params.severity "disrupted" }} - ▲ + ▲ {{ else }} - ◆ + ◆ {{ end }} {{ T "downtimeOngoing" }} diff --git a/layouts/partials/meta.html b/layouts/partials/meta.html index a5f6472..bcd3967 100644 --- a/layouts/partials/meta.html +++ b/layouts/partials/meta.html @@ -29,7 +29,7 @@ margin: 0; background: #fff; color: #4d4d4d; - font: 100%/1.5 'Inter', "Inter UI", BlinkMacSystemFont, -apple-system, "San Francisco Text", "Roboto", "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + font: 100%/1.5 "Inter", "Inter UI", BlinkMacSystemFont, -apple-system, "San Francisco Text", "Roboto", "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; box-sizing: border-box; -webkit-tap-highlight-color: rgba(0,0,0, 0.25); } @@ -66,7 +66,7 @@ h1, h2, h4 { font-weight: normal; color: #000; - font-family: 'Inter', "Inter UI", "Segoe UI", BlinkMacSystemFont, -apple-system, "San Francisco Display", "Roboto", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + font-family: "Inter", "Inter UI", "Segoe UI", BlinkMacSystemFont, -apple-system, "San Francisco Display", "Roboto", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; letter-spacing: -0.4px; } @@ -332,30 +332,64 @@ } } - /** - * Dark theme - */ + {{ if not .Site.Params.disableDarkMode }} + /** + * Dark theme + */ + + @media (prefers-color-scheme: dark) { + /* Basics */ + html, body { background: #181a1b; color: #ccc9c1; } + h1, h2, h3, h4, a, .bold { color: #fafafa; } + hr { border-bottom-color: #3d3d3d; } + + /* Sections */ + .footer { background: #1b1d1e; } + + .components { + border: 2px solid #ddd; + border-bottom: 0; + border-color: #3a3a3a; + } - @media (prefers-color-scheme: dark) { - html, body { background: #181a1b; color: #ccc9c1; } - h1, h2, h3, h4, a, .bold { color: #e8e6e3; } - hr { border-bottom-color: #3d3d3d; } - .footer { background: #1b1d1e; } - .date { color: #c3bfb6; } - .components { border: 2px solid #ddd; border-bottom: 0; border-color: #3a3a3a; } - .component { border-bottom: 2px solid #ddd; color: #e8e6e3; border-bottom-color: #3a3a3a; } - .tag { background-image: initial; background-color: #1d1f20; } - .tag:hover { background: #222; } - .issue:hover {background-color: #1b1d1e } - .error { color: #ff4242; } - .hinted, .faded { color: #c1bcb3; } - .warning {color: #ff8b52; } - .ok { color: #7fff7f; } - .component[data-status="disrupted"] - .component-status { color: #ff8b52; } - .component[data-status="ok"] - .component-status { color: #7fff7f; } + .component { + border-bottom: 2px solid #ddd; + color: #e8e6e3; + border-bottom-color: #3a3a3a; } + + .tabs { border-bottom-color: #3d3d3d; } + .tab--current { + border-color: #3d3d3d; + border-bottom-color: #181a1b; + } + .tab--other { color: #757575; } + .tab--other:hover { color: #fff; } + + .date { color: #c3bfb6; } + + .tag { background-color: #1d1f20; } + .tag:hover { background: #222; } + .issue:hover, + .category__head:hover { background-color: #212121; } + + /* Colors for dark mode */ + + .hinted, .faded { color: #c1bcb3; } + .error { color: #ff4242; } + .warning {color: #ffde7f; } + .ok { color: #7fff7f; } + + .component[data-status="ok"] + .component-status { color: #7fff7f; } + .component[data-status="disrupted"] + .component-status { color: #ffde7f; } + .component[data-status="notice"] + .component-status { color: #83a4e8; } + .component[data-status="down"] + .component-status { color: #ff8181; } + } + {{ end }} {{ if .Site.Params.enableCustomHTML }} {{ partial "custom/meta" . }} -- cgit v1.2.3-70-g09d2 From d04adae5f8ac3e8296b2efc1c455abdafc37eb60 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sun, 15 Dec 2019 12:37:26 +0200 Subject: Fix #83 - hex colors now need hash --- exampleSite/config.yml | 24 +++++++++++++----------- layouts/partials/meta.html | 42 +++++++++++++++++++++--------------------- static/admin/config.yml | 20 ++++++++++---------- 3 files changed, 44 insertions(+), 42 deletions(-) diff --git a/exampleSite/config.yml b/exampleSite/config.yml index 98f95c0..3e474b1 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -237,20 +237,22 @@ params: incidentPostsPerPage: 10 # Colors throughout cState - # HEX codes without the # + # + # We recommend using HEX + # (with the # symbol). # # Defaults: # - # brand: "0a0c0f" - # ok: "008000" - # disrupted: "cc4400" - # down: "e60000" - # notice: "24478f" - brand: "0a0c0f" - ok: "008000" - disrupted: "cc4400" - down: "e60000" - notice: "24478f" + # brand: "#0a0c0f" + # ok: "#008000" + # disrupted: "#cc4400" + # down: "#e60000" + # notice: "#24478f" + brand: "#0a0c0f" + ok: "#008000" + disrupted: "#cc4400" + down: "#e60000" + notice: "#24478f" # If the status page shows that # there are disruptions or outages diff --git a/layouts/partials/meta.html b/layouts/partials/meta.html index bcd3967..d953331 100644 --- a/layouts/partials/meta.html +++ b/layouts/partials/meta.html @@ -13,13 +13,13 @@ {{ printf `` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }} {{ end -}} - + @@ -95,9 +95,9 @@ .clean { margin: 0; } - .ok { color: #{{ .Site.Params.ok }}; } - .warning { color: #{{ .Site.Params.disrupted }}; } - .error { color: #{{ .Site.Params.down }}; } + .ok { color: {{ .Site.Params.ok }}; } + .warning { color: {{ .Site.Params.disrupted }}; } + .error { color: {{ .Site.Params.down }}; } .contain { max-width: 640px; @@ -157,7 +157,7 @@ .header { padding: 8px 0; - background: #{{ .Site.Params.brand }}; + background: {{ .Site.Params.brand }}; } .header a { @@ -295,18 +295,18 @@ * Specific to the status */ - .status-ok .summary { background: #{{ .Site.Params.ok }}; } - .status-disrupted .summary, .change-header-color.status-disrupted .header { background: #{{ .Site.Params.disrupted }}; } - .status-down .summary, .change-header-color.status-down .header { background: #{{ .Site.Params.down }}; } - .status-notice .summary, .change-header-color.status-notice .header { background: #{{ .Site.Params.notice }}; } + .status-ok .summary { background: {{ .Site.Params.ok }}; } + .status-disrupted .summary, .change-header-color.status-disrupted .header { background: {{ .Site.Params.disrupted }}; } + .status-down .summary, .change-header-color.status-down .header { background: {{ .Site.Params.down }}; } + .status-notice .summary, .change-header-color.status-notice .header { background: {{ .Site.Params.notice }}; } .announcement-box .padding { padding: 16px; } - .status-disrupted .announcement-box { border: 2px solid #{{ .Site.Params.disrupted }}; } - .status-down .announcement-box { border: 2px solid #{{ .Site.Params.down }}; } - .status-notice .announcement-box { border: 2px solid #{{ .Site.Params.notice }}; } + .status-disrupted .announcement-box { border: 2px solid {{ .Site.Params.disrupted }}; } + .status-down .announcement-box { border: 2px solid {{ .Site.Params.down }}; } + .status-notice .announcement-box { border: 2px solid {{ .Site.Params.notice }}; } .status-disrupted .announcement-box, .status-down .announcement-box, .status-notice .announcement-box { border-top: 0; } @@ -316,10 +316,10 @@ */ .component-status { float: right; } - .component[data-status="ok"] .component-status { color: #{{ .Site.Params.ok }}; } - .component[data-status="disrupted"] .component-status { color: #{{ .Site.Params.disrupted }}; } - .component[data-status="down"] .component-status { color: #{{ .Site.Params.down }}; } - .component[data-status="notice"] .component-status { color: #{{ .Site.Params.notice }}; } + .component[data-status="ok"] .component-status { color: {{ .Site.Params.ok }}; } + .component[data-status="disrupted"] .component-status { color: {{ .Site.Params.disrupted }}; } + .component[data-status="down"] .component-status { color: {{ .Site.Params.down }}; } + .component[data-status="notice"] .component-status { color: {{ .Site.Params.notice }}; } /** * Responsiveness diff --git a/static/admin/config.yml b/static/admin/config.yml index 1b64060..0827f66 100644 --- a/static/admin/config.yml +++ b/static/admin/config.yml @@ -201,30 +201,30 @@ collections: default: true # Colors - label: 'Site HEX color: Brand' - hint: 'Should not have # mark. Default: 181818' + hint: 'Use any color type, even rgb() works. We recommend HEX: #123456. Default: #0a0c0f' name: 'brand' widget: 'string' - default: '181818' + default: '#0a0c0f' - label: 'Site HEX color: Operational / OK' - hint: 'Should not have # mark. Default: 228B22' + hint: 'Use any color type, even rgb() works. We recommend HEX: #123456. Default: #008000' name: 'ok' widget: 'string' - default: '228B22' + default: '#008000' - label: 'Site HEX color: Disrupted' - hint: 'Should not have # mark. Default: FF8C00' + hint: 'Use any color type, even rgb() works. We recommend HEX: #123456. Default: #cc4400' name: 'disrupted' widget: 'string' - default: 'FF8C00' + default: '#cc4400' - label: 'Site HEX color: Down / Offline / Major' - hint: 'Should not have # mark. Default: DC143C' + hint: 'Use any color type, even rgb() works. We recommend HEX: #123456. Default: #e60000' name: 'down' widget: 'string' - default: 'DC143C' + default: '#e60000' - label: 'Site HEX color: Notice' - hint: 'Should not have # mark. Default: 708090' + hint: 'Use any color type, even rgb() works. We recommend HEX: #123456. Default: #24478f' name: 'notice' widget: 'string' - default: '708090' + default: '#24478f' # Google Analytics - label: 'Google Analytics tracking code' hint: 'By default, cState does not use Google Analytics. If you choose to use it, you may change the placeholder code below to your own and thereby enable the tracking service. If you set the value back to UA-00000000-1, the code will once again be removed.' -- cgit v1.2.3-70-g09d2 From a658ba5a121bb17f1ac2a4ed3acacf335e5f729f Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sun, 15 Dec 2019 13:23:12 +0200 Subject: Update documentation and version --- CONTRIBUTING.md | 18 ++++++++++---- README.md | 58 +++++++++++++++++++++++++++------------------- layouts/index.json | 4 ++-- layouts/partials/js.html | 2 +- layouts/partials/meta.html | 2 +- 5 files changed, 52 insertions(+), 32 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58825c5..02b3e53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for taking the time to contribute. Folks like you are more than welcome! ## I want to suggest something, report a bug, etc. -Cool, [just create an issue](https://github.com/cstate/cstate/issues)! +[Please create an issue](https://github.com/cstate/cstate/issues)! ## I want to write code. @@ -17,12 +17,22 @@ Some guidelines. You want to make sure that you have: * Looked, if there was an issue for the thing you are trying to achieve * If there isn't, create one and discuss your proposal in that issue. -The code you write should be readable to humans. If it is not immediately obvious, add some comments. +The code you write should be: + ++ working as intended, ++ spaced out instead of being in all one big pile, ++ readable to humans. If it is not immediately obvious, add some comments. ## I want to translate [Read this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations). -## Wait, my question has not been answered. +## I want to support the project + +Please **star, share, and use the software**. Thank you, if you do. + +If you wish to support the project financially: + +[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas) -At the time of writing, cState is such a small project that anyone contributing would be a downright miracle. However, if you are a miracle worker, please do redirect any concerns and they will addressed as soon as humanely possible. [Just create an issue](https://github.com/cstate/cstate/issues)! +[Support the author on PayPal](https://www.paypal.me/mistermantas) \ No newline at end of file diff --git a/README.md b/README.md index 5a047c5..bd4bd8a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

-> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify & GitHub Pages. +> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify, Netlify CMS. [**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com) @@ -17,7 +17,7 @@ + [Updating](#updating-) + [FAQ](#faq-) + [Contribute](#contribute-) -* [Donate](#donate-) +* [Support](#support-) + [License](#license-) *** @@ -26,16 +26,17 @@ **Designed with care** +* **New in v4**: automatically ships with dark mode + Comes with a simple, focused, and extremely light design -+ Works not just on mobile, but also on the archaic Internet Explorer 8 ++ Works not just on mobile, but also on the archaic Internet Explorer 8 for some reason + Makes you accountable, showcasing how long it took for an issue to be resolved + Great for data manipulation and viewing — has RSS, tag-like system feeds -+ Customizable views, colors, and other elements ++ Customizable views, colors, HTML, and other elements **Fast, reliable, and free (even to host)** + Built with [Hugo](https://gohugo.io), a hyperfast Golang generator -+ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/) ++ Secure, ready for HTTPS; see [JAMstack](https://jamstack.org/) + Easy to edit and deploy on Netlify for _absolutely free_ **Easy to setup, manage, use** @@ -43,7 +44,8 @@ + Edit your status page from a simple config file + Comes pre-equipped with Netlify CMS for quick admin updates + Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki) -+ [Read-only API available](https://github.com/cstate/cstate/wiki/API) ++ You can not only create issues, but also informational, about pages ++ **New in v4**: [Read-only API available](https://github.com/cstate/cstate/wiki/API) ## Getting started 💻 @@ -119,24 +121,28 @@ If you would like to commit/make a PR, make sure that `themesDir` is a comment b ## Updating 🎉 -Assuming the production install instructions were followed, keep cState updated by having an up to date Git submodule in the `themes` folder. containing this repository. Your content will stay separate, as to avoid any conflicts. +**If you are updating from one major version to another, like from v3 to v4, then please [read the migration guides](https://github.com/cstate/cstate/wiki/Usage#migration-guides).** -If you already have a Git repository set up with a filled up `themes/cstate` folder, then all you need to do is this: +Assuming the production install instructions were followed, keep cState updated by having an up to date Git submodule in the `themes` folder. containing this repository. Your content will stay separate. -```bash -git submodule foreach git pull origin master -``` +Ask yourself these questions: -If you have previously used Netlfiy CMS or have made other changes without using the command line, the easiest thing to do is just clone it in a new place, change it how you want to, push those changes, and then you can safely remove the Git folder. So, do this: +1. Do I already have the **up to date** Git repository with my status page on my computer? + * If not, go to your desktop or somewhere else, where you can download your Git repository and run: `git clone --recursive && git submodule foreach git pull origin master`. + * In the parent directory, type `hugo serve`. Check to see if everything is working. + * Then do `git add -A; git commit -m "Update cState"; git push origin master; exit`. Your status page is now updated. +2. If you **DO** have the directory, go inside `themes/cstate`. If that is empty, it is easier to delete your local copy and do the steps outlined earlier. -```bash -git clone --recursive && git submodule foreach git pull origin master -``` +There is currently no easier way to do this, unfortunately, you will need the terminal / command line / Git Bash, unless you want to create a new status page from scratch and move your data over manually. -More info about submodules on [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules). +More info about submodules: [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules). ## FAQ 🤔 +### Are there settings you can change? + +Yes, most of the settings are in the `config.yml` file or under _Settings_ in Netlify CMS. + ### Where do issues go? #### Using an admin panel (Netlify CMS) @@ -178,24 +184,28 @@ Time to break that down. Check out [the wiki](https://github.com/cstate/cstate/wiki). -## Donate ❤️ +## Support ❤️ + +cState is only a hobby project of @mistermantas, but it has turned into something a little bit bigger. + +Please **star, share, and use the software**. Thank you, if you do. + +If you wish to support the project financially: -cState is only a hobby project of @mistermantas, but it’s a prideful one. +[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas) -Support the developer and ensure the future of the project by donating for a cuppa tea, some ice cream, or if you are feeling generous — a large size pizza. +[Support the author on PayPal](https://www.paypal.me/mistermantas) -* [PayPal](https://paypal.me/AlbinaV} -* or you can make a bank transfer. For info, [get in touch](https://mnts.lt) ## Contribute 💥 -> Want to become a maintainer? Hit me up! [@mistermantas](https://twitter.com/mistermantas) +> Want to become a maintainer? Hit me up [on Twitter @mistermantas](https://twitter.com/mistermantas) + Glance over the [Code of Conduct](/CODE_OF_CONDUCT.md). + Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues). + Or if you are a translator — [see this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations). -+ Write consistent, simple, readable code and precise documentation. -+ Version numbers should be added in JS partial & meta generator tags! ++ Write consistent, simple, readable code, and precise documentation. ++ Version numbers should be added in the JS partial, the meta[generator] tag, and API index! ## License ✍ diff --git a/layouts/index.json b/layouts/index.json index c2a2c49..3a2c299 100644 --- a/layouts/index.json +++ b/layouts/index.json @@ -5,8 +5,8 @@ {{ $isDown := where $active "Params.severity" "=" "down" }} { "is": "index", - "cStateVersion": "4.0", - "apiVersion": "1.0", + "cStateVersion": "4.0.0", + "apiVersion": "1.0.0", "title": "{{ .Site.Title }}", "languageCodeHTML": "{{ .Site.LanguageCode }}", "languageCode": "{{ T "languageCode" }}", diff --git a/layouts/partials/js.html b/layouts/partials/js.html index 54a0176..7740d85 100644 --- a/layouts/partials/js.html +++ b/layouts/partials/js.html @@ -3,7 +3,7 @@ * Dev toolset */ - console.log('cState v4.0.0 - Dev 2019-10-06 - https://github.com/cstate/cstate'); + console.log('cState v4.0.0 - rc1 2019-12-15 - https://github.com/cstate/cstate'); document.getElementsByTagName('html')[0].className = 'js'; /** diff --git a/layouts/partials/meta.html b/layouts/partials/meta.html index d953331..19ac00c 100644 --- a/layouts/partials/meta.html +++ b/layouts/partials/meta.html @@ -12,7 +12,7 @@ {{ range .AlternativeOutputFormats -}} {{ printf `` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }} {{ end -}} - +