README.md 8.4 KB
Newer Older
Mantas's avatar
Mantas committed
1
<p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.svg?sanitize=true" alt="cState example illustration"></p>
Mantas's avatar
v2-dev2    
Mantas committed
2

3
<p align="center"><a href="https://github.com/cstate/cstate/releases"><img src="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square" alt="GitHub release" /></a> <a href="https://github.com/cstate/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square" alt="GitHub last commit" /></a> <a href="https://github.com/cstate/cstate/tree/master/"><img src="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square" alt="GitHub repo size in bytes" /></a> <a href="https://discord.gg/EvQZdhT"><img src="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square" alt="Discord Chat" /></a> <a href="https://twitter.com/cstate"><img src="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&amp;label=Follow" alt="Twitter" /></a> <a href="https://github.com/ivbeg/awesome-status-pages"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome status page" /></a></p>
Mantas's avatar
v2-dev2    
Mantas committed
4

5
> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify & GitHub Pages.
6

7
[**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
Mantas's avatar
Mantas committed
8

9
[👩‍💻 You can also see what an example cState project’s source code.](https://github.com/cstate/example)
Mantas's avatar
v2-rc1    
Mantas committed
10

11
## Contents ⁉
12

13
14
+ [Features](#features-)
+ [Getting started](#getting-started-)
Mantas's avatar
Mantas committed
15
16
  + [Production](#production)
  + [Development](#development)
17
18
19
20
+ [Updating](#updating-)
+ [FAQ](#faq-)
+ [Contribute](#contribute-)
+ [License](#license-)
21

Mantas's avatar
Mantas committed
22
23
***

24
25
26
## Features 😎

**Designed with care**
Mantas's avatar
Mantas committed
27

28
+ Comes with a simple, focused, and extremely light design
29
30
31
32
33
34
35
36
37
38
39
40
+ Works not just on mobile, but also on the archaic Internet Explorer 8
+ Makes you accountable, showcasing how long it took for an issue to be resolved
+ Great for data manipulation and viewing — has RSS, tag-like system feeds

**Fast, reliable, and free**

+ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator
+ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/)
+ Easy to edit and deploy on Netlify for _absolutely free_

**Easy to setup, manage, use**

Mantas's avatar
Mantas committed
41
42
+ Edit your status page from a simple config file
+ Comes pre-equipped with Netlify CMS for quick admin updates
Mantas's avatar
v2-rc1    
Mantas committed
43
+ Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki)
Mantas's avatar
Mantas committed
44

45
## Getting started 💻
Mantas's avatar
Mantas committed
46
47

For this tutorial, it is assumed that you have Hugo and Git installed (check with `hugo version` & `git --version`).
Mantas's avatar
Mantas committed
48

49
50
> A minimum version of `0.48` is required for Hugo, starting with v3.

Mantas's avatar
Mantas committed
51
#### Production
Mantas's avatar
Mantas committed
52

53
54
55
56
We encourage you to use [Netlify](https://www.netlify.com) for cState. These are the following options you need to change in deploy settings:

+ Build command: **hugo**
+ Publish directory: **public**
Mantas's avatar
Mantas committed
57
+ Add one build environment variable
58
  + Key: **HUGO_VERSION**
59
  + Value: **0.48**
Mantas's avatar
Mantas committed
60

Mantas's avatar
Mantas committed
61
62
63
64
65
66
67
68
**The easy way**

You can simply click this button to get started:

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/cstate/example)

This sets up cState with its default settings from the cstate/example repo.

Mantas's avatar
Mantas committed
69
***
Mantas's avatar
Mantas committed
70

Mantas's avatar
Mantas committed
71
72
If you want to do this from any branch in this repository, follow the manual instructions:

Mantas's avatar
Mantas committed
73
74
1. Download the contents of the `exampleSite` directory in this repository. This will be your site guts, which will hold the content and configuration for the status page.
2. Create a `themes` folder and navigate to it on the command line.
Mantas's avatar
Mantas committed
75

76
```bash
Mantas's avatar
Mantas committed
77
78
mkdir themes; cd themes;
```
Mantas's avatar
Mantas committed
79

Mantas's avatar
Mantas committed
80
3. Now simply add a Git submodule pointing to this repository, like so:
81

Mantas's avatar
Mantas committed
82
```bash
Mantas's avatar
v2-rc1    
Mantas committed
83
git submodule add https://github.com/cstate/cstate
84
```
85

Mantas's avatar
Mantas committed
86
4. Set up cState for your liking. It is now ready to be used in production.
Mantas's avatar
Mantas committed
87
88

#### Development
89

Mantas's avatar
Mantas committed
90
1. Clone this repository in the command line:
91

Mantas's avatar
Mantas committed
92
```bash
Mantas's avatar
v2-rc1    
Mantas committed
93
git clone https://github.com/cstate/cstate.git
Mantas's avatar
Mantas committed
94
```
95

Mantas's avatar
Mantas committed
96
2. Navigate to the theme directory:
97
98

```bash
99
cd cstate/exampleSite
Mantas's avatar
Mantas committed
100
```
101

Mantas's avatar
Mantas committed
102
3. Launch the development setup much like this:
103

Mantas's avatar
Mantas committed
104
```bash
105
hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../.. --verbose
106
107
```

Mantas's avatar
Mantas committed
108
109
110
The main directory is the theme itself (the cState guts, basically) and the `exampleSite` folder houses all content. Use this local setup to experiment before deploying to production!

If you would like to commit/make a PR, make sure that `themesDir` is a comment before trying to merge upstream.
111

112
## Updating 🎉
113

Mantas's avatar
Mantas committed
114
Assuming the production install instructions were followed, keep cState updated by having an up to date Git submodule in the `themes` folder. containing this repository. Your content will stay separate, as to avoid any conflicts.
115

Mantas's avatar
Mantas committed
116
If you already have a Git repository set up with a filled up `themes/cstate` folder, then all you need to do is this:
Mantas's avatar
Mantas committed
117

118
```bash
Mantas's avatar
Mantas committed
119
git submodule foreach git pull origin master
120
121
```

Mantas's avatar
Mantas committed
122
123
124
If you have previously used Netlfiy CMS or have made other changes without using the command line, the easiest thing to do is just clone it in a new place, change it how you want to, push those changes, and then you can safely remove the Git folder. So, do this:

```bash
Mantas's avatar
Mantas committed
125
git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master
Mantas's avatar
Mantas committed
126
127
128
```

More info about submodules on [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules).
Mantas's avatar
Mantas committed
129

130
## FAQ 🤔
Mantas's avatar
Mantas committed
131

Mantas's avatar
Mantas committed
132
133
134
135
136
137
138
### Where do issues go?

#### Using an admin panel (Netlify CMS)

This takes a little more effort to set up but pays off in the long run — [see the wiki](https://github.com/cstate/cstate/wiki) for up to date information.

#### Doing it from the Git repository
139

140
Create a file in `content/issues`. The name of the file will be the slug (what shows up in the URL bar). For example, this is what `2017-02-30-major-outage-east-us.md` should look like:
141
142
143

```md
---
Mantas's avatar
Mantas committed
144
145
title: Major outage in East US
date: 2017-02-30 14:30:00
SUNNY's avatar
SUNNY committed
146
resolved: true
Mantas's avatar
Mantas committed
147
148
149
resolvedWhen: 2017-02-30 16:00:00
severity: down
affected:
Mantas's avatar
Mantas committed
150
  - API
Mantas's avatar
Mantas committed
151
section: issue
152
153
---

Mantas's avatar
Mantas committed
154
*Monitoring* - After hitting the ole reboot button Example Chat App is now recovering. We’re going to continue to monitor as everyone reconnects. {{< track "2018-04-13 16:50:00" >}}
Mantas's avatar
Mantas committed
155

Mantas's avatar
Mantas committed
156
*Investigating* - We’re aware of users experiencing unavailable guilds and issues when attempting to connect. We're currently investigating. {{< track "2018-04-13 15:54:00" >}}
157
158
```

159
160
Time to break that down.

Mantas's avatar
Mantas committed
161
162
163
164
165
166
167
`title`: This is the one of the most important parts of an incident. *(required)*  
`date`: An ISO-8601 formatted date. Does not include time zone. This is when you first discovered the issue. *(required)*  
`resolved`: Whether issue should affect overall status. Either `true` or `false`. *(boolean, required)*  
`resolvedWhen`: An ISO-8601 formatted date. Does not include time zone. This is when downtime stopped. You may set the time that downtime ended without completely resolving the issue (thus leaving time for monitoring).  
`severity`: If an issue is not resolved, it will have an applied severity. There are 3 levels of severity: `notice`, `disrupted`, and `down`. If there are multiple issues, the status page will take the appearance of the more drastic issue (such as `disrupted` instead of `notice`). *(required)*  
`affected`. Add the items that were present in the config file which should alter the status of each individual system (component). *(array, required)*  
`section`. This must be `issue`, so that Hugo treats it as one. *(required)*  
168

Mantas's avatar
v2-rc1    
Mantas committed
169
170
171
172
### I have more questions!

Check out [the wiki](https://github.com/cstate/cstate/wiki).

173
## Contribute 💥
174

175
> Want to become a maintainer? Hit me up! [@mistermantas](https://twitter.com/mistermantas)
Mantas's avatar
Mantas committed
176

177
+ Glance over the [Code of Conduct](/CODE_OF_CONDUCT.md).
Mantas's avatar
v2-rc1    
Mantas committed
178
+ Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues).
179
+ Or if you are a translator — [see this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations).
Mantas's avatar
Mantas committed
180
+ Write consistent, simple, readable code and precise documentation.
181
182
183
+ Version numbers should be added in JS partial & meta generator tags!

## License ✍
184

185
[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://github.com/mistermantas)
186

187
Thanks to all the [contributors](https://github.com/cstate/cstate/graphs/contributors)!