Skip to content

Commit 5253f95

Browse files
committed
doc: Initial doc for statuspage
1 parent 2d24dad commit 5253f95

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

doc/statuspage.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# StatusPage
2+
3+
This document relates to the [StatusPage](https://www.statuspage.io/) for Node.js, which can be
4+
found at [status.nodejs.org](https://status.nodejs.org).
5+
6+
## Access
7+
8+
The following people have access to the StatusPage control panel. New accounts can be added via the
9+
[User Management](https://manage.statuspage.io/organizations/m3074zj4qnr9/team) page.
10+
11+
Access to StatusPage is unrestricted, so anyone in this list can make changes to the styling of
12+
the page, change what components are listed, see who is subscribed to notifications (PII: emails,
13+
phone numbers) and manage incidents on the page.
14+
15+
The only additional "permission" is that one email address is considered the owner of the
16+
status page. This account cannot be removed by other members and acts as the official owner of the
17+
page for communication with the StatusPage folks if needed.
18+
19+
| GitHub | Email (for StatusPage access) | Role |
20+
|------------------------------------------------|--------------------------------|--------|
21+
| [@MattIPv4](https://github.com/MattIPv4) | [email protected] | Owner |
22+
| [@brianwarner](https://github.com/brianwarner) | [email protected] | Member |
23+
24+
## Twitter
25+
26+
There is also a Twitter account, [@NodejsStatus](https://twitter.com/NodejsStatus), for the
27+
status page.
28+
29+
This account is run by [@MattIPv4](https://github.com/MattIPv4) via [email protected],
30+
but is added to the [Twitter integration](https://manage.statuspage.io/pages/rxy2rhgm8q1n/twitter)
31+
on StatusPage and will automatically tweet any incidents created on the page.
32+
33+
## Customisations
34+
35+
The [statuspage](../statuspage) directory in this repository contains a backup of the major
36+
customisations applied to the Node.js status page. These should be updated whenever the
37+
customisations are changed on the status page.
38+
39+
[colors.md](../statuspage/colors.md) contains the custom color set for the whole status page
40+
(including emails for subscribers) in
41+
[Your Page > Customize page and emails > Colors](https://manage.statuspage.io/pages/rxy2rhgm8q1n/design#colors-container).
42+
43+
[styles.scss](../statuspage/styles.scss) stores the custom styling that is applied to all web pages
44+
of the Node.js StatusPage site. This is controlled from the
45+
[Customize HTML & CSS](https://manage.statuspage.io/pages/rxy2rhgm8q1n/full-customize) view
46+
accessed from the button top-right on
47+
[Your Page > Customize page and emails > Customize status page](https://manage.statuspage.io/pages/rxy2rhgm8q1n/design#design-container).
48+
49+
[header.html](../statuspage/header.html) contains the custom HTML used for the header on the
50+
status page. It is important to note that this replaces the default header (logo & subscribe
51+
button), so using this should be avoided if possible. Like the custom styling, this is managed from
52+
the [Customize HTML & CSS](https://manage.statuspage.io/pages/rxy2rhgm8q1n/full-customize) page.
53+
54+
[footer.html](../statuspage/footer.html) contains custom HTML injected into the footer of the
55+
status page website. This doesn't replace any default content and is a good place for custom
56+
scripting if needed. This is also controlled from the
57+
[Customize HTML & CSS](https://manage.statuspage.io/pages/rxy2rhgm8q1n/full-customize) page.

0 commit comments

Comments
 (0)