README.md 8.86 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

Casper's avatar
Casper committed
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/zYCjzys"><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
+ [Updating](#updating-)
+ [FAQ](#faq-)
+ [Contribute](#contribute-)
Mantas's avatar
Mantas committed
20
* [Donate](#donate-)
21
+ [License](#license-)
22

Mantas's avatar
Mantas committed
23
24
***

25
26
27
## Features 😎

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

29
+ Comes with a simple, focused, and extremely light design
30
31
32
33
34
35
36
37
38
39
40
41
+ 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
42
43
+ 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
44
+ Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki)
Mantas's avatar
Mantas committed
45

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

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

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

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

54
55
56
57
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
58
+ Add one build environment variable
59
  + Key: **HUGO_VERSION**
60
  + Value: **0.48** (or later)
Mantas's avatar
Mantas committed
61

Mantas's avatar
Mantas committed
62
63
64
65
66
67
68
69
**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
70
***
Mantas's avatar
Mantas committed
71

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

Mantas's avatar
Mantas committed
74
75
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
76

77
```bash
Mantas's avatar
Mantas committed
78
79
mkdir themes; cd themes;
```
Klaus's avatar
Klaus committed
80
81
82
83
84
2. Start Git on this folder: 

```bash
git init
```
Mantas's avatar
Mantas committed
85

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

Mantas's avatar
Mantas committed
88
```bash
Mantas's avatar
v2-rc1    
Mantas committed
89
git submodule add https://github.com/cstate/cstate
90
```
91

Mantas's avatar
Mantas committed
92
4. Set up cState for your liking. It is now ready to be used in production.
Mantas's avatar
Mantas committed
93
94

#### Development
95

Mantas's avatar
Mantas committed
96
1. Clone this repository in the command line:
97

Mantas's avatar
Mantas committed
98
```bash
99
git clone --recurisve https://github.com/cstate/cstate.git
Mantas's avatar
Mantas committed
100
```
101

Mantas's avatar
Mantas committed
102
2. Navigate to the theme directory:
103
104

```bash
105
cd cstate/exampleSite
Mantas's avatar
Mantas committed
106
```
107

Mantas's avatar
Mantas committed
108
3. Launch the development setup much like this:
109

Mantas's avatar
Mantas committed
110
```bash
111
hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../.. --verbose
112
113
```

Mantas's avatar
Mantas committed
114
115
116
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.
117

118
## Updating 🎉
119

Mantas's avatar
Mantas committed
120
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.
121

Mantas's avatar
Mantas committed
122
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
123

124
```bash
Mantas's avatar
Mantas committed
125
git submodule foreach git pull origin master
126
127
```

Mantas's avatar
Mantas committed
128
129
130
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
131
git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master
Mantas's avatar
Mantas committed
132
133
134
```

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
135

136
## FAQ 🤔
Mantas's avatar
Mantas committed
137

Mantas's avatar
Mantas committed
138
139
140
141
142
143
144
### 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
145

146
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:
147
148
149

```md
---
Mantas's avatar
Mantas committed
150
151
title: Major outage in East US
date: 2017-02-30 14:30:00
SUNNY's avatar
SUNNY committed
152
resolved: true
Mantas's avatar
Mantas committed
153
154
155
resolvedWhen: 2017-02-30 16:00:00
severity: down
affected:
Mantas's avatar
Mantas committed
156
  - API
Mantas's avatar
Mantas committed
157
section: issue
158
159
---

Mantas's avatar
Mantas committed
160
*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
161

Mantas's avatar
Mantas committed
162
*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" >}}
163
164
```

165
166
Time to break that down.

Mantas's avatar
Mantas committed
167
168
169
170
171
172
173
`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)*  
174

Mantas's avatar
v2-rc1    
Mantas committed
175
176
177
178
### I have more questions!

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

Mantas's avatar
Mantas committed
179
180
181
182
183
184
185
186
187
## Donate ❤️

cState is only a hobby project of @mistermantas, but it’s a prideful one.

Support the developer and ensure the future of the project by donating for a cuppa tea, some ice cream, or if you are feeling generous — a large size pizza.

* [PayPal](https://paypal.me/AlbinaV}
* or you can make a bank transfer. For info, [get in touch](https://mnts.lt)

188
## Contribute 💥
189

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

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

## License ✍
199

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

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