Skip to content

Commit d9840d5

Browse files
committed
doc(statuspage): initial doc for statuspage
1 parent 9e39fa9 commit d9840d5

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

doc/statuspage.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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://admin.atlassian.com/s/f6b1a2fe-1302-40aa-9a3f-4f7523370639/users) page.
10+
11+
Atlassian StatusPage has three groups available, `site-admins` that have full administration access
12+
in Atlassian, `statuspage-administrators` that have full administration access specifically for the
13+
StatusPage product, and `statuspage-users` who have regular operational access to StatusPage.
14+
15+
Atlassian organizations also have a separate concept of org-wide administrators, that have full
16+
access to everything (this is technically different from `site-admins` as that is scoped to the
17+
"site", but this org only has one site, so they are effectively the same).
18+
19+
| GitHub | Site Role | Org Admin |
20+
|------------------------------------------------|--------------------|-----------|
21+
| [@MattIPv4](https://github.com/MattIPv4) | `site-admins` | Yes |
22+
| OpenJSF Operations | `site-admins` | Yes |
23+
| [@MylesBorins](https://github.com/MylesBorins) | `statuspage-users` | No |
24+
25+
## Twitter
26+
27+
There is also a Twitter account, [@NodejsStatus](https://twitter.com/NodejsStatus), for the
28+
status page.
29+
30+
This account is run via the
31+
[Twitter integration](https://manage.statuspage.io/pages/rxy2rhgm8q1n/twitter) on StatusPage and
32+
will automatically tweet any incident updates (if tweeting is selected for an incident update).
33+
34+
## Customisations
35+
36+
The [statuspage](../statuspage) directory in this repository contains a backup of the major
37+
customisations applied to the Node.js status page. These should be updated whenever the
38+
customisations are changed on the status page.
39+
40+
[colors.md](../statuspage/colors.md) contains the custom color set for the whole status page
41+
(including emails for subscribers) in
42+
[Your Page > Customize page and emails > Colors](https://manage.statuspage.io/pages/rxy2rhgm8q1n/design#colors-container).
43+
44+
[styles.scss](../statuspage/styles.scss) stores the custom styling that is applied to all web pages
45+
of the Node.js StatusPage site. This is controlled from the
46+
[Customize HTML & CSS](https://manage.statuspage.io/pages/rxy2rhgm8q1n/full-customize) view
47+
accessed from the button top-right on
48+
[Your Page > Customize page and emails > Customize status page](https://manage.statuspage.io/pages/rxy2rhgm8q1n/design#design-container).
49+
50+
[header.html](../statuspage/header.html) contains the custom HTML used for the header on the
51+
status page. It is important to note that this replaces the default header (logo & subscribe
52+
button), so using this should be avoided if possible. Like the custom styling, this is managed from
53+
the [Customize HTML & CSS](https://manage.statuspage.io/pages/rxy2rhgm8q1n/full-customize) page.
54+
55+
[footer.html](../statuspage/footer.html) contains custom HTML injected into the footer of the
56+
status page website. This doesn't replace any default content and is a good place for custom
57+
scripting if needed. This is also controlled from the
58+
[Customize HTML & CSS](https://manage.statuspage.io/pages/rxy2rhgm8q1n/full-customize) page.

0 commit comments

Comments
 (0)