Introduction

Netlify StatusKit is a template to deploy your own Status pages on Netlify.

Netlify StatusKit is released under the MIT License. Please make sure you understand its implications and guarantees.

Extra configuration

After the site is created, you can modify the code as much as you want and push it to your GitHub repository. Netlify will pick up changes from there.

Reporting systems

You can add systems you want to report about to your Status page. For instance, you might want to tell your users about a status change in your CDN infrastructure but not in your API.

Go to site/config.toml and change the global systems variables. Once that's done, you'll be able to change the status of each one of those systems individually when you open or modify an incident.

Managing incidents

Incidents are plain markdown files inside the site/content/incidents directory.

Creating new incidents

Adding incidents to your status page is as simple as adding a new document to the incidents collection. Create a new incident using npm:

npm run new-incident

You'll be asked a series of questions about the incident, then Hugo will generate a new file pre-filled with your responses.

After explaining the current situation in the incident, you can just push the file to GitHub. Netlify will deploy the incident announcement for you in a matter of seconds.

Resolving incidents

Everything will be operational again when all incidents are marked with resolved = true in the incident frontMatter:

+++
...
affectedsystems = ["API"]
resolved = true
+++

Tracking activity

When there is an update in your incident you can track activity by inserting a timestamp with the update. For example:

**Update**: We've identified the issue. {{< track "2016-11-22T14:34:00.000Z" >}}

You can get the current date in a browser by running new Date().toISOString();

hugo-sid / agrc-status