cState is now stable on v3.0 - 2019-01-24 (info: #41)

README.md

@@ -1,43 +1,53 @@
-<p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.png" alt="cState"></p>
+<p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.svg" alt="Example of what cState looks like"></p>
 
-<p align="center"><a href="https://github.com/cstate/cstate/releases"><img src="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square" alt="GitHub release" /></a> <a href="https://github.com/cstate/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square" alt="GitHub last commit" /></a> <a href="https://github.com/cstate/cstate/tree/master/"><img src="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square" alt="GitHub repo size in bytes" /></a> <a href="https://discord.gg/EvQZdhT"><img src="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square" alt="Discord Chat" /></a> <a href="https://twitter.com/cstate"><img src="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&amp;label=Follow" alt="Twitter" /></a> <a href="https://github.com/matiassingers/awesome-readme#readme"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome README" /></a></p>
+<p align="center"><a href="https://github.com/cstate/cstate/releases"><img src="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square" alt="GitHub release" /></a> <a href="https://github.com/cstate/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square" alt="GitHub last commit" /></a> <a href="https://github.com/cstate/cstate/tree/master/"><img src="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square" alt="GitHub repo size in bytes" /></a> <a href="https://discord.gg/EvQZdhT"><img src="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square" alt="Discord Chat" /></a> <a href="https://twitter.com/cstate"><img src="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&amp;label=Follow" alt="Twitter" /></a> <a href="https://github.com/ivbeg/awesome-status-pages"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome status page" /></a></p>
 
-> Ü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 & GitHub Pages.
 
-[**Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
+[**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
 
-[You can also see what an example cState project’s source code.](https://github.com/cstate/example)
+[👩‍💻 You can also see what an example cState project’s source code.](https://github.com/cstate/example)
 
-*Looking for contributors! See Contribute section:*
+## Contents ⁉
 
-## Contents
-
-+ [Features](#features)
-+ Getting started
++ [Features](#features-)
++ [Getting started](#getting-started-)
   + [Production](#production)
   + [Development](#development)
-+ [Updating](#updating)
-+ [FAQ](#faq)
-+ [Contribute](#contribute)
-+ [License](#license)
++ [Updating](#updating-)
++ [FAQ](#faq-)
++ [Contribute](#contribute-)
++ [License](#license-)
 
 ***
 
-## Features
+## Features 😎
+
+**Designed with care**
 
-+ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator
-+ Works not just on mobile, but also on the archaic Internet Explorer 8
 + Comes with a simple, focused, and extremely light design
++ Works not just on mobile, but also on the archaic Internet Explorer 8
++ 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
+
+**Fast, reliable, and free**
+
++ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator
++ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/)
++ Easy to edit and deploy on Netlify for _absolutely free_
+
+**Easy to setup, manage, use**
+
 + Edit your status page from a simple config file
 + Comes pre-equipped with Netlify CMS for quick admin updates
-+ Easy to edit and deploy on Netlify or GitHub Pages
-+ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/)
 + Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki)
 
-## Getting started
+## Getting started 💻
 
 For this tutorial, it is assumed that you have Hugo and Git installed (check with `hugo version` & `git --version`).
 
+> A minimum version of `0.48` is required for Hugo, starting with v3.
+
 #### Production
 
 We encourage you to use [Netlify](https://www.netlify.com) for cState. These are the following options you need to change in deploy settings:
@@ -46,7 +56,7 @@ We encourage you to use [Netlify](https://www.netlify.com) for cState. These are
 + Publish directory: **public**
 + Add one build environment variable
   + Key: **HUGO_VERSION**
-  + Value: **0.41**
+  + Value: **0.48**
 
 **The easy way**
 
@@ -86,20 +96,20 @@ git clone https://github.com/cstate/cstate.git
 2. Navigate to the theme directory:
 
 ```bash
-cd cstate-master
+cd cstate/exampleSite
 ```
 
 3. Launch the development setup much like this:
 
 ```bash
-hugo serve --baseUrl=/ --theme=cstate-master --themesDir=../..
+hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../.. --verbose
 ```
 
 The main directory is the theme itself (the cState guts, basically) and the `exampleSite` folder houses all content. Use this local setup to experiment before deploying to production!
 
 If you would like to commit/make a PR, make sure that `themesDir` is a comment before trying to merge upstream.
 
-## Updating
+## 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.
 
@@ -117,7 +127,7 @@ git clone --recursive <your repo link goes here> && git submodule foreach git pu
 
 More info about submodules on [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules).
 
-## FAQ
+## FAQ 🤔
 
 ### Where do issues go?
 
@@ -127,7 +137,7 @@ This takes a little more effort to set up but pays off in the long run — [see
 
 #### Doing it from the Git repository
 
-Create a file in `content/issues`. The name of the file will be the slug (what shows up in the URL bar). For example, this is what `major-outage-east-us.md` should look like:
+Create a file in `content/issues`. The name of the file will be the slug (what shows up in the URL bar). For example, this is what `2017-02-30-major-outage-east-us.md` should look like:
 
 ```md
 ---
@@ -160,15 +170,18 @@ Time to break that down.
 
 Check out [the wiki](https://github.com/cstate/cstate/wiki).
 
-## Contribute
+## Contribute 💥
 
-cState needs help to grow, not only would it benefit from stuff like unit tests, but also get influenced by fresh ideas to grow even further.
+> Want to become a maintainer? Hit me up! [@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.
-+ You may also use the mnts [Discord chat](https://discord.gg/EvQZdhT) for support.
++ Version numbers should be added in JS partial & meta generator tags!
+
+## License ✍
 
-## License
+[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://github.com/mistermantas)
 
-[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © Mantas Vilčinskas
+Thanks to all the [contributors](https://github.com/cstate/cstate/graphs/contributors)!

archetypes/default.md

@@ -3,7 +3,7 @@ title:
 date:
 resolved:
 resolvedWhen:
-# down, disrupted, notice
+# You can use: down, disrupted, notice
 severity:
 affected:
 section: issue

exampleSite/README.txt

@@ -0,0 +1,3 @@
+This is the default cState status page website directory/folder.
+
+https://github.com/cstate/example

exampleSite/config.yml

@@ -6,9 +6,8 @@
 
 # Welcome to the cState configuration file!
 #
-# This is the configuration file for v2.0!
 # If you are using an earlier version, or one
-# in the future, such as v3, you may see errors
+# in the future, such as v8.0 you may see errors
 # pop up when deploying a cState website.
 #
 # Now, onto the fun part.
@@ -44,24 +43,54 @@
 
 # What is your status page called?
 # Shows up in the browser bar and meta tags
-title: Eggsample App Status
+title: Eggsample Status
 
-# What language is this site using?
-# Only alters the html[lang] attribute
+# Should posts, which have a publish date
+# from the future, be built? Useful for
+# sharing upcoming maintenance, etc.
+#
+# We recommend to keep this at `true`.
+# BOOLEAN; `true`, `false`
+buildFuture: true
+
+# What language do you want to use for the
+# html[lang] definition?
 #
+# Does not change language of site
+# itself.
+#
+# Default: `en`
 # ISO 639-1 defines abbreviations.
+#
 # See:  https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
 # Also: https://www.w3schools.com/tags/ref_language_codes.asp
 languageCode: en
 
+# What translation file should cState use?
+# You can also define whether missing
+# translations should get placeholders.
+#
+# For defaultContentLanguage—
+# Default: `en`
+#
+# For enableMissingTranslationPlaceholders—
+# do not set it to true for languages other
+# than English! When tested with Lithuanian,
+# it would add unnecesary placeholders to
+# values that were intentionally empty.
+defaultContentLanguage: en
+
 # What is the hostname or path to the root?
 # Where is the site hosted?
 #
-# Slash enables relative links.
+# 💥 cState & Hugo don’t support / in
+# production use. It will break RSS
+# feeds and breaks permalinks since
+# version 3. If you are just testing,
+# localhost should automatically work.
 #
-# Default: /
 # Example: https://status.example.com/
-baseURL: /
+baseURL: https://status.example.com
 
 ############################################################
 # +------------------------------------------------------+ #
@@ -76,15 +105,24 @@ params:
   # For help, see the wiki:
   # https://github.com/cstate/cstate/wiki/Customization
   systems:
-    -
-      name: Gateway
-    -
-      name: API
+    - name: Gateway
+    - name: API
       description: The guts of the application.
-    -
-      name: Media Proxy
+    - name: Media Proxy
       description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN.
 
+  # What date format to use?
+  #
+  # Hugo formatting docs:
+  # https://gohugo.io/functions/format/#hugo-date-and-time-templating-reference
+  #
+  # Technical: GOLANG/HUGO .Date.Format & dateFormat
+  #
+  # dateFormat Default: "January 2, 2006 at 3:04 PM"
+  # shortDateFormat Default: "15:04 — Jan 2"
+  dateFormat: January 2, 2006 at 3:04 PM
+  shortDateFormat: 15:04 — Jan 2
+
   # What header design should we use?
   #
   # Default: true
@@ -109,7 +147,7 @@ params:
   logo: /logo.png
 
   # This is the description that is shown
-  # in the footer and meta tags.
+  # on the footer and meta tags.
   #
   # Default: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here.
   description: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here.
@@ -146,12 +184,12 @@ params:
   #
   # brand: #181818
   # ok: 228B22
-  # warning: DC143C
-  # down: FF8C00
+  # warning: EE7600
+  # down: DC143C
   # notice: 708090
   brand: 181818
   ok: 228B22
-  disrupted: FF8C00
+  disrupted: EE7600
   down: DC143C
   notice: 708090
 
@@ -181,29 +219,12 @@ params:
   # Default: UA-00000000-1
   googleAnalytics: UA-00000000-1
 
-############################################################
-# +------------------------------------------------------+ #
-# |                 For developers                       | #
-# +------------------------------------------------------+ #
-############################################################
-
-# Should posts, which have a publish date
-# from the future, be built? Useful for
-# sharing upcoming maintenance, etc.
-#
-# We recommend to keep this at `true`.
-# BOOLEAN; `true`, `false`
-buildFuture: true
-
 # These options affect the core of cState.
 # Please do not change them if you do not
 # know what you are doing.
 theme: cstate
 
-# This option tells cState what version
-# your config file is using.
-#
-# Never ever remove this, nor change it,
-# if you have not updated to any other
-# version.
-version: 2
+preserveTaxonomyNames: true
+
+taxonomies:
+  affected: affected

exampleSite/content/issues/2018-01-17-sending-dms-impacted.md

@@ -0,0 +1,15 @@
+---
+title: Issues Sending DMs
+date: 2018-01-17 16:24:00
+resolved: true
+resolvedWhen: 2018-01-17 16:58:00
+# Possible severity levels: down, disrupted, notice
+severity: disrupted
+affected:
+  - API
+section: issue
+---
+
+*Update* - This incident has been resolved.
+
+*Investigating* - We're aware of an issue affecting sending DMs and viewing online friends. We're online and working on a resolution.

exampleSite/content/issues/unavailable-guilds-connection-issues.md → exampleSite/content/issues/2018-04-13-unavailable-guilds-connection-issues.md

@@ -3,7 +3,7 @@ title: Unavailable Guilds & Connection Issues
 date: 2018-04-13 15:54:00
 resolved: true
 resolvedWhen: 2018-04-13 17:30:00
-# down, disrupted, notice
+# Possible severity levels: down, disrupted, notice
 severity: down
 affected:
   - API

exampleSite/content/issues/us-east-conn-issues.md → exampleSite/content/issues/2018-05-25-us-east-conn-issues.md

@@ -2,11 +2,12 @@
 title: US East Connection Issues
 date: 2018-05-25 04:13:00
 resolved: true
-resolvedWhen: 2018-05-25 04:40:00
-# down, disrupted, notice
+resolvedWhen: 2018-05-25 04:13:59
+# Possible severity levels: down, disrupted, notice
 severity: disrupted
 affected:
   - API
+  - Media Proxy
 section: issue
 ---
 

exampleSite/content/issues/2018-06-13-maintenance-window.md

@@ -0,0 +1,13 @@
+---
+title: Maintenance Window
+date: 2018-06-13 15:54:00
+resolved: false
+resolvedWhen: 2018-06-13 17:30:00
+# Possible severity levels: down, disrupted, notice
+severity: notice
+affected:
+  - API
+section: issue
+---
+
+*Just began* - We're currently shutting down the network. {{< track "2018-06-13 15:54:00" >}}