This is the main status page for ABS web services. It is manually updated so information may be delayed.
Once the repo is cloned on your computer, create a new incident locally using npm:
npm run new
Netlify StatusKit is released under the MIT License.
On Netlify, the environment variables listed here are filled in:
STATUSKIT_PAGE_TITLE
- Title to show in the browser for your status site.STATUSKIT_COMPANY_LOGO
- URL to your company's logo.STATUSKIT_SUPPORT_CONTACT_LINK
- URL to a support page for your users to talk with you.STATUSKIT_RESOURCES_LINK
- URL to documentation for your users.
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.
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.
This template is based in Netlify's Victor-Hugo boilerplate.
To work on it you'll need NPM installed. To download dependencies type npm run dependencies
, that will check if you have Hugo installed and will download it for you if you don't. It will also run npm install
for the first time to download extra dependencies. After that, you can run npm install
every time you want to install packages.
Incidents are plain markdown files inside the site/content/incidents
directory.
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
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 indicent announcement for you in a matter of seconds.
Everything will be operational again when all incidents are marked with resolved = true
in the incident frontMatter:
+++
...
affectedsystems = ["API"]
resolved = true
+++
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" >}}
Netlify StatusKit uses NPM to manage dependencies. It also bundles a version of Hugo to work out of the box.
- Use
npm install
to download dependencies. - Use
npm start
to start the development server.