cState v5 #151

mistermantas · 2020-10-27T20:15:51Z

Migration guide

v4 to v5

Some considerations:

The new way of handling time means ALL DATES AND TIMES MUST be in UTC. Netlify CMS, for example, should automatically set the time to UTC in the frontmatter, without you doing anything.
The new way of handling time might screw up your archives. If you did not use UTC for ALL issues before, consider or not upgrading your site and starting anew (from scratch). It's as easy as clicking Deploy to Netlify from the README and setting the old site as an archive, linking it to the footer, if you'd like.
There aren't many breaking changes unless you rely on informational or the resolved variables for issues. Those are now booleans instead of strings.
API may not work for versions earlier than 0.73 -- testing happens on 0.80 term is needed to be added as an output method to the config file, but it got renamed in one of the versions etc etc. Some context: Rename taxonomy kinds gohugoio/hugo#6911

What you MUST change:

config.yml

At the very bottom or top of your config.yml, if you wish to use the Last modified feature, add this:

# For features like Last modified, you
# need to use a Git repository. If you
# are using Netlify, you are already
# using Git (with GitHub, GitLab, etc)
#
# So, should Git information be used
# for this website?
#
# We recommend to keep this at `true`.
# BOOLEAN; `true`, `false`
enableGitInfo: true

Next, here are the newly introduced options. You can disable all these (or not even copy paste this bit) and use cState as usual.

  # Should relative time (x min ago) be used?
  #
  # IMPORTANT: In the frontmatter, the dates MUST be in
  # the UTC time zone for this to work preperly. If you 
  # use Netlify CMS, all good — the CMS picks UTC time
  # by default. Otherwise, there may be very inaccurate
  # times if multiple time zones are in your issue files.
  #
  # FOR YOUR CONSIDERATION: This feature was introduced in
  # v5. It may be a breaking change in the case when you
  # wish to use relative time but old issues do not have
  # UTC time (and therefore are out of sync by ±24 hours)
  #
  # Read the wiki for more: 
  # https://github.com/cstate/cstate/wiki/Customization#time 
  #
  # If enabled, will display relative times in places like
  # the incident history and summaries instead of using
  # dateFormat and shortDateFormat (except for if you use
  # the old shortcode).
  #
  # Default: `true`
  # BOOLEAN; `true`, `false`
  useRelativeTime: true

  # If enabled, doesn't show seconds on relative times.
  #
  # With option ON (true):
  # "Last checked <1 min ago"
  #
  # With option OFF (false; default):
  # "Last checked 20s ago"
  #
  # Default: `false`
  # BOOLEAN; `true`, `false`
  skipSeconds: false

  # Should there be an automatic "Last updated"
  # text shown below issues?
  #
  # Default: `true`
  # BOOLEAN; `true`, `false`
  enableLastMod: true

If you will use relative time, and therefore UTC, consider editing the dateFormat for people who do not use JavaScript (and other fallbacks). Copy and change the options to this:

  dateFormat: January 2, 2006 at 3:04 PM UTC
  shortDateFormat: 15:04 UTC — Jan 2

To make the API work flawlessy, change the Output Formats to this:

outputs:
  page:
    - html
    - json
  section:
    - html
    - json
    - rss
  home:
    - html
    - json
    - rss
    - svg
  term:
    - html
    - json
    - rss

Upgrade to Hugo 0.80

On Netlify, make sure you are using Ubuntu 16.04 (not the old build image) in Build & deploy settings. You can change the HUGO VERSION in the Environment Variables from the Netlify UI or also edit the netlify.toml file.

netlify.toml / vercel.json

Add this to your netlify.toml for your site if you don't have it already:

[build.environment]
    HUGO_VERSION = "0.80.0"

[[headers]]
    for = "/*.json"
    [headers.values]
      Access-Control-Allow-Origin = "*"

Docs for headers: https://docs.netlify.com/routing/headers/#multi-value-headers

Vercel equivalent (made by contributor);

{
  "headers": [
    {
      "source": "/(.*)",
      "headers": [
        { "key": "Access-Control-Allow-Origin", "value": "*" },
        { "key": "Access-Control-Allow-Methods", "value": "GET,OPTIONS" },
        { "key": "Access-Control-Allow-Headers", "value": "X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version" }
      ]
    }
  ]
}

Changelog

This update brings a lot of requested and long-awaited features, also some bug fixes to your status page.

A different (better) way of handling time — #139 (#128, #135, also see #123)

What is time? It is an important element for a status page to get right. And there are so many ways to show the time. But some are more confusing than others.

Prior to v5, cState did not give too much thought about what kind of time zone the user was in. Yes, there were (and still are) relative calculations of "how long an outage takes", but does the end user know exactly in which time zone at 6PM the issue began?

date: 2019-10-04 18:05:00

For small countries like Lithuania, there is one time zone that everybody is familiar with — GMT+2 in our case. So you could have the time and date, as shown in the config, be 'synced' to Eastern European/Lithuanian time. Would be confusing for people in vastly different time zones like those of North America, but it might not be a big issue for some.

If you have an international user base, then this is a real problem. Again, your company in San Francisco could choose to use the time in that specific region and add on to the date text that we are using this time zone, not another one. Still, this can be prove to be annoying.

For new setups, cState defaults to relative time and ASSUMES YOU USE UTC TIME.

Thanks to all the people who suggested and worked on this feature, most notably @khamer.

Expanded read-only JSON API (version 2!)

There are lots of updates to the API to make it actually useful. Read here

There aren't many breaking changes unless you rely on informational or the resolved variables for issues. Those are now booleans instead of strings.

Also see #159

Are you looking for a monitor bot or extension to show when something is down on your site?

Check out the new cState project HTML Embed

Other new features

Last modified

lastMod (last modified date) is now available through the newer, v2, API and I am trying to figure out how to implement it properly in the UI. There's a param in config.yml enableLastMod if you want to check it out.

Category status

Now when a category is closed you can see the status of it. #101 Groups take on the status of their most degraded child components/systems. Opening the category, like always, shows the individual statuses. This feature is only available with JavaScript on.

On new websites, Vercel deployments will automatically allow cross-origin requests

Introduced in #176 from @jacobhq — copy the file introduced in the new exampleSite directory (or cstate/example repo when v5 goes live to production) to use this functionality for the API.

Things requiring attention of some users:

On new sites cross origin on Vercel works Allow cross origin on Vercel deployments #176 from @jacobhq (add file if upgrading)
Updates to Docker by Nevexo from Docker: entrypoint script fixes #162 (see Docker docs in wiki)
Added Tagalog translation by @TheWhackFactory from Tagalog translations #153
Added Italian translation by @Enrico204 from Add Italian translation #166
Bug with Google Analytics now fixed!

Minor changes include:

Slight improvements to XML
Improved documentation and code style
Added "Hyrousek" status page Added "Hyrousek" status page #155
Added Josh.win status page
"All systems operational" changed to "No issues detected" in English language file

… 'data-time-suffix'

These changes replace the CRLF line endings on entrypoint.sh (#160) and adds more debugging messages for diagnosing issues with the docker side of cState in the future.

I was confused when reading the sample config file, as explained in issue #164. "don't support /" could have meant a trailing slash, or subdirectories, or at least wasn't exactly clear to me. By adding an explicit example of a broken behavior, we make it clear what we're talking about here, and what to avoid. Closes: #164

Allow cross origin on Vercel deployments

khamer and others added 7 commits October 27, 2020 21:38

fix automatic reload logic

e8e5038

Add .relative-time class and JS logic

78b3b15

fix IE bug; rename 'data-prefix' to 'data-time-prefix' and add unused…

656f716

… 'data-time-suffix'

add .Site.Params.useRelativeTime

f5e7f88

add .Site.Params.skipSeconds

49c081a

uniform comment style

dfbbdfc

Added "Hyrousek" status page

9ba5e70

multimac mentioned this pull request Nov 21, 2020

Allow displaying times in users local timezone #157

Closed

mistermantas added 2 commits December 12, 2020 12:27

Add Tagalog by @TheWhackFactory from #153

761533c

Add Tagalog by @TheWhackFactory from #153

9f95ce0

mistermantas changed the title ~~cState Next Release Dev PR~~ cState v5 Dec 12, 2020

mistermantas and others added 11 commits December 15, 2020 20:37

Netlify mention

f191b32

Docker: line endings & verbose messages

9556f03

These changes replace the CRLF line endings on entrypoint.sh (#160) and adds more debugging messages for diagnosing issues with the docker side of cState in the future.

Add Italian translation

01d74a9

Down is better indicated in Italian with "disservizio"

74e388a

Add Italian into the Netlify CMS config file

1b0c725

explain BaseURL on NCMS

d9837b1

forestry/vercel

9320bf6

Remove twitter

867f6a5

Doc updates, bugfixes, add rel time to NCMS

925027e

API v2 Index features

9647734

mistermantas mentioned this pull request Feb 24, 2021

Add JSON to affected #159

Closed

API updates, lastmod, NCMS/default config changes, version to 0.80

548fcb9

mistermantas mentioned this pull request Feb 24, 2021

Showing local time automatically with JS - timezone conundrum #123

Closed

mistermantas added 5 commits February 24, 2021 17:09

Automatic monitoring not possible

63c8b6d

All ok to no issues detected

9bbc616

fix #101 - add category status, #161 ref in config.yml

d64bfe7

Improve README

a69adf3

Improve Netlify.toml

6cf928c

mistermantas and others added 7 commits March 6, 2021 17:34

Clean up README

730ffa6

cleanup

ad77f48

Update README.md

7aac467

Add Josh's page and follow Cf branding

64556b4

Allow cross origin on Vercel deployments

a95d82d

Allow cross origin on Vercel deployments #176 from @jacobhq

ff67482

Allow cross origin on Vercel deployments

v5 ready to deploy

740f8fe

mistermantas merged commit 18500f7 into master Apr 17, 2021

mistermantas deleted the dev branch April 17, 2021 11:34

Sarveshmrao mentioned this pull request Aug 8, 2021

Netlify Build Fails #201

Closed

mistermantas mentioned this pull request Dec 25, 2021

Time Calculations #220

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

cState v5 #151

cState v5 #151

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cState v5 #151

cState v5 #151

Uh oh!

Conversation

Uh oh!

Migration guide

v4 to v5

config.yml

Upgrade to Hugo 0.80

netlify.toml / vercel.json

Changelog

A different (better) way of handling time — #139 (#128, #135, also see #123)

Expanded read-only JSON API (version 2!)

Are you looking for a monitor bot or extension to show when something is down on your site?

Other new features

Things requiring attention of some users:

Minor changes include:

Uh oh!

Uh oh!