cState v4.0 Final (#82)

cState v4.0 Final

1 files changed, 85 insertions, 12 deletions

diff --git a/exampleSite/config.yml b/exampleSite/config.yml
index 74d30b4..3e474b1 100644
--- a/exampleSite/config.yml
+++ b/exampleSite/config.yml
@@ -83,7 +83,7 @@ defaultContentLanguage: en
 # What is the hostname or path to the root?
 # Where is the site hosted?
 #
-# 💥 cState & Hugo don’t support '/' in
+# ❗ cState & Hugo don’t support '/' in
 # production use. It will break RSS
 # feeds and breaks permalinks since
 # version 3. If you are just testing,
@@ -99,6 +99,35 @@ baseURL: https://cstate.mnts.lt
 ############################################################
 
 params:
+  # Before setting up your systems, you need
+  # to first define at least one category.
+  #
+  # Categories are shown in the order that
+  # you define in this config file.
+  #
+  # Categories can have a:
+  # - name
+  # - description
+  # - closed boolean `closed: true`
+  #   That would collapse the category upon first load
+  #   and the user can expand by clicking on the category
+  #   (Requires JavaScript.)
+  # - untitled boolean `untitled: true`
+  #   This would complerely hide the name of the category.
+  #   This is useful, if you do not want to use categories
+  #   because you need to set an 'Uncategorized' category.
+  #   Or it can be used alongside other categories.
+  #
+  # For help, see the wiki:
+  # https://github.com/cstate/cstate/wiki/Customization
+  categories:
+    - name: North Coast
+      description: The main servers are located here.
+      closed: true
+    - name: East Coast      
+    - name: Uncategorized
+      untitled: true
+
   # These are your systems. Change them to
   # change the amount of components.
   #
@@ -106,10 +135,15 @@ params:
   # https://github.com/cstate/cstate/wiki/Customization
   systems:
     - name: Gateway
+      category: North Coast
+    - name: Backup Gateway
+      category: East Coast
     - name: API
       description: The guts of the application.
+      category: Uncategorized
     - name: Media Proxy
       description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN.
+      category: Uncategorized
 
   # What date format to use?
   #
@@ -129,6 +163,30 @@ params:
   # BOOLEAN; `true`, `false`
   useLargeHeaderDesign: false
 
+  # Should incident history be separated
+  # like in an archive view?
+  #
+  # Note: This WILL disable pagination.
+  #
+  # Default: `yearly`
+  # 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?
   #
@@ -179,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
@@ -229,3 +289,16 @@ preserveTaxonomyNames: true
 
 taxonomies:
   affected: affected
+
+outputs:
+  page:
+    - html
+    - json
+  section:
+    - html
+    - json
+    - rss
+  home:
+    - html
+    - json
+    - rss