https://github.com/stencila/status
Stencila's status reporting
https://github.com/stencila/status
status-page stencila
Last synced: 4 months ago
JSON representation
Stencila's status reporting
- Host: GitHub
- URL: https://github.com/stencila/status
- Owner: stencila
- License: apache-2.0
- Created: 2021-04-18T23:03:05.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-05T19:55:43.000Z (over 1 year ago)
- Last Synced: 2025-03-30T17:24:02.505Z (about 1 year ago)
- Topics: status-page, stencila
- Language: JavaScript
- Homepage: https://stencila.github.io/status/
- Size: 742 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚦Status
**Stencila's status reporting**
## 👋 Introduction
This repository is for Stencila's status reporting and https://status.stenci.la. We use [Statusfy](https://statusfy.co/) to create and update incident reports. The site is automatically built and deployed by Azure CI.
Incident reports do not have to be only for degraded performance or outages. Stencila team members are encouraged to create report for maintenance tasks, using the `under-maintenance` severity tag, so that users have an indication that there may be some instability.
## 🏃♀️ Getting started
```
git clone git@github.com:stencila/status
cd status
npm install
npm run dev
```
## 🚨 Create an incident report
Either create a new Markdown file for the incident in [`content`](content), or run,
```sh
npm run new-incident
```
See the [docs](https://docs.statusfy.co/guide/incidents) and the previous incident reports for more on how to write the Markdown.
Then to deploy the new report,
```sh
git add content
git commit -m "Add incident report"
git push
```
The CI will generate the status page and publish it on Github Pages at https://status.stenci.la. You can check the status of the CI build themselves here: [](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=7&branchName=master).
If you want to bypass the CI (you're in a hurry, or it's broken), you can just do:
```sh
npm run publish
```
Use `npm run dev` if you wish to preview any changes before publishing.
## ⏲️ Update an incident report
Either edit the existing Markdown file for the incident located in [`content`](content), or run,
```sh
npm run update-incident
```
Then to deploy the update,
```sh
git commit -m "Update incident report on..."
git push
```
## 🙏 Acknowledgments
Thanks to the developers of [Statusfy](https://statusfy.co/) which powers this status page.