<palign="center"><imgsrc="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.svg"alt="Example of what cState looks like"></p>
<palign="center"><ahref="https://github.com/cstate/cstate/releases"><imgsrc="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square"alt="GitHub release"/></a><ahref="https://github.com/cstate/cstate/commits/master"><imgsrc="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square"alt="GitHub last commit"/></a><ahref="https://github.com/cstate/cstate/tree/master/"><imgsrc="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square"alt="GitHub repo size in bytes"/></a><ahref="https://discord.gg/EvQZdhT"><imgsrc="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square"alt="Discord Chat"/></a><ahref="https://twitter.com/cstate"><imgsrc="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&label=Follow"alt="Twitter"/></a><ahref="https://github.com/matiassingers/awesome-readme#readme"><imgsrc="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"alt="Awesome README"/></a></p>
<palign="center"><ahref="https://github.com/cstate/cstate/releases"><imgsrc="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square"alt="GitHub release"/></a><ahref="https://github.com/cstate/cstate/commits/master"><imgsrc="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square"alt="GitHub last commit"/></a><ahref="https://github.com/cstate/cstate/tree/master/"><imgsrc="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square"alt="GitHub repo size in bytes"/></a><ahref="https://discord.gg/EvQZdhT"><imgsrc="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square"alt="Discord Chat"/></a><ahref="https://twitter.com/cstate"><imgsrc="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&label=Follow"alt="Twitter"/></a><ahref="https://github.com/ivbeg/awesome-status-pages"><imgsrc="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"alt="Awesome status page"/></a></p>
> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely free with Netlify & GitHub Pages.
> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify & GitHub Pages.
[**Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
[**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
[You can also see what an example cState project’s source code.](https://github.com/cstate/example)
[👩💻 You can also see what an example cState project’s source code.](https://github.com/cstate/example)
*Looking for contributors! See Contribute section:*
## Contents ⁉
## Contents
+[Features](#features)
+ Getting started
+[Features](#features-)
+[Getting started](#getting-started-)
+[Production](#production)
+[Development](#development)
+[Updating](#updating)
+[FAQ](#faq)
+[Contribute](#contribute)
+[License](#license)
+[Updating](#updating-)
+[FAQ](#faq-)
+[Contribute](#contribute-)
+[License](#license-)
***
## Features
## Features 😎
**Designed with care**
+ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator
+ Works not just on mobile, but also on the archaic Internet Explorer 8
+ Comes with a simple, focused, and extremely light design
+ 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**
+ Edit your status page from a simple config file
+ Comes pre-equipped with Netlify CMS for quick admin updates
+ Easy to edit and deploy on Netlify or GitHub Pages
+ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/)
+ Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki)
## Getting started
## Getting started 💻
For this tutorial, it is assumed that you have Hugo and Git installed (check with `hugo version` & `git --version`).
> A minimum version of `0.48` is required for Hugo, starting with v3.
#### Production
We encourage you to use [Netlify](https://www.netlify.com) for cState. These are the following options you need to change in deploy settings:
...
...
@@ -46,7 +56,7 @@ We encourage you to use [Netlify](https://www.netlify.com) for cState. These are
hugo serve --baseUrl=/ --theme=cstate-master--themesDir=../..
hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../..--verbose
```
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.
## Updating
## Updating 🎉
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.
...
...
@@ -117,7 +127,7 @@ git clone --recursive <your repo link goes here> && git submodule foreach git pu
More info about submodules on [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules).
## FAQ
## FAQ 🤔
### Where do issues go?
...
...
@@ -127,7 +137,7 @@ This takes a little more effort to set up but pays off in the long run — [see
#### Doing it from the Git repository
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 `major-outage-east-us.md` should look like:
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:
```md
---
...
...
@@ -160,15 +170,18 @@ Time to break that down.
Check out [the wiki](https://github.com/cstate/cstate/wiki).
## Contribute
## Contribute 💥
cState needs help to grow, not only would it benefit from stuff like unit tests, but also get influenced by fresh ideas to grow even further.
> Want to become a maintainer? Hit me up! [@mistermantas](https://twitter.com/mistermantas)
+ Glance over the [Code of Conduct](/CODE_OF_CONDUCT.md).
+ Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues).
+ Or if you are a translator — [see this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations).
+ Write consistent, simple, readable code and precise documentation.
+ You may also use the mnts [Discord chat](https://discord.gg/EvQZdhT) for support.
+ Version numbers should be added in JS partial & meta generator tags!
translation:Uh oh! It looks like you have disabled JavaScript. Please
-id:noScriptingLink
translation:enable scripting
-id:noScriptingOutro
translation:to enhance your experience on this website.
-id:thisIsDown
translation:Down
-id:thisIsDisrupted
translation:Disrupted
-id:thisIsNotice
translation:Maintenance
-id:thisIsOk
translation:Operational
# "Last checked" + "just now"
-id:lastChecked
translation:Last checked
-id:justNow
translation:just now
-id:someTimeAgo
translation:ago
# Example usage: `5` + `years`
# Final result: 'Last checked 5 years ago'
# Number goes before string
# Use short variants until months
-id:yearsAgo
translation:years
-id:monthsAgo
translation:months
-id:daysAgo
translation:d
-id:hoursAgo
translation:h
-id:minsAgo
translation:min
-id:secondsAgo
translation:s
-id:autoRefreshNotice
translation:We will try to refresh every 5 min
# Incidents
-id:incidents
translation:Incidents
-id:incidentHistory
translation:Incident history
-id:resolved
translation:Resolved# if it's less than a min
-id:inUnderAMinute
translation:in under a minute# continuing the last string
-id:resolvedAfter
translation:Resolved after# + 19 min
-id:ofDowntime
translation:of downtime
-id:downtimeOngoing
translation:Unresolved!
-id:calmBeforeTheStorm
translation:Is it the calm before the storm?
-id:noIncidentsDesc
translation:This status page has no logged incidents. This may be because the status page owner (or owners) have recently set up their status page, have had no downtime, or have not logged any downtime.
-id:continueReading
translation:Continue reading
-id:prev
translation:Previous
-id:next
translation:Next
##
## OTHER
##
-id:goBack
translation:Go back to
-id:backToTop
translation:Back to top
-id:poweredBy
translation:Powered by
-id:notFound
translation:There is nothing here.
-id:notFoundText
translation:This could be a problem on our part. Perhaps we moved a certain resource and now it is gone. It is also possible that the resource you are trying to view is empty (for example, if a system has never been down, we have nothing to show). But do you also mind to double check the link?
translation:O ne! Jūsų interneto naršyklė neturi įjungto JavaScript. Tam, kad galėtume peržiūrėti daugumą šiuolaikinių interneto svetainių, reikia turėti įdiegtą JavaScript. Rekomenduoje
-id:noScriptingLink
translation:peržiūrėti šias instrukcijas,
-id:noScriptingOutro
translation:jei norite išnaudoti visas šios svetainės funkcijas.
-id:thisIsDown
translation:Neveikia
-id:thisIsDisrupted
translation:Yra trukdžių
-id:thisIsNotice
translation:Remontuojama
-id:thisIsOk
translation:Veikia
# "Last checked" + "just now"
-id:lastChecked
translation:Paskutinį kartą atnaujinta prieš
-id:justNow
translation:<5s
# - id: someTimeAgo
# translation: # not used
# Example usage: `5` + `years`
# Final result: 'Last checked 5 years ago'
# Number goes before string
# Use short variants until months
-id:yearsAgo
translation:met.
-id:monthsAgo
translation:mėn.
-id:daysAgo
translation:d
-id:hoursAgo
translation:val.
-id:minsAgo
translation:min.
-id:secondsAgo
translation:s
-id:autoRefreshNotice
translation:Bandome automatiškai atnaujinti informaciją kas 5 min.
# Incidents
-id:incidents
translation:Incidentai
-id:incidentHistory
translation:Incidentų išrašai
-id:resolved
translation:Išspręsta problema# if it's less than a min
-id:inUnderAMinute
translation:minutės# continuing the last string
-id:resolvedAfter
translation:Išspręsta problema po# + 19 min # not used
#- id: ofDowntime
# translation: of downtime
-id:downtimeOngoing
translation:Dar sprendžiama problema
-id:calmBeforeTheStorm
translation:Kol kas nėra jokių incidentų.
-id:noIncidentsDesc
translation:Šiame puslapyje nėra užregistruotų incidentų. Gali būti todėl, kad puslapio savininkas (arba savininkai) neseniai sukūrė šią svetainę, neturėjo incidentų šiame laiko tarpe arba neužregistravo incidentų sistemoje.
-id:continueReading
translation:Skaityti toliau
-id:prev
translation:Ankstesnis
-id:next
translation:Kitas
##
## OTHER
##
-id:goBack
translation:Eiti atgal į
-id:backToTop
translation:Eiti į viršų
-id:poweredBy
translation:Ši svetainė sukurta su
-id:notFound
translation:Čia nieko nėra.
-id:notFoundText
translation:Tai gali būti mūsų problema — galbūt puslapis, kurį bandote peržiūrėti, buvo kitur perkeltas arba buvo ištrintas. Taip pat yra galimybė, jog puslapis yra tuščias (pvz. jeigu vienas komponentas mūsų sistemoje nėra turėjęs problemų, nėra ko rodyti). Rekomenduoje dar kartą patikrinti, ar nuoroda, kurią naudojate, nėra neteisinga.
