Commit a658ba5a authored by Mantas Vilčinskas's avatar Mantas Vilčinskas
Browse files

Update documentation and version

parent d04adae5
......@@ -4,7 +4,7 @@ Thanks for taking the time to contribute. Folks like you are more than welcome!
## I want to suggest something, report a bug, etc.
Cool, [just create an issue](https://github.com/cstate/cstate/issues)!
[Please create an issue](https://github.com/cstate/cstate/issues)!
## I want to write code.
......@@ -17,12 +17,22 @@ Some guidelines. You want to make sure that you have:
* Looked, if there was an issue for the thing you are trying to achieve
* If there isn't, create one and discuss your proposal in that issue.
The code you write should be readable to humans. If it is not immediately obvious, add some comments.
The code you write should be:
+ working as intended,
+ spaced out instead of being in all one big pile,
+ readable to humans. If it is not immediately obvious, add some comments.
## I want to translate
[Read this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations).
## Wait, my question has not been answered.
## I want to support the project
Please **star, share, and use the software**. Thank you, if you do.
If you wish to support the project financially:
[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas)
At the time of writing, cState is such a small project that anyone contributing would be a downright miracle. However, if you are a miracle worker, please do redirect any concerns and they will addressed as soon as humanely possible. [Just create an issue](https://github.com/cstate/cstate/issues)!
[Support the author on PayPal](https://www.paypal.me/mistermantas)
\ No newline at end of file
......@@ -2,7 +2,7 @@
<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>
> Ü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, Netlify CMS.
[**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
......@@ -17,7 +17,7 @@
+ [Updating](#updating-)
+ [FAQ](#faq-)
+ [Contribute](#contribute-)
* [Donate](#donate-)
* [Support](#support-)
+ [License](#license-)
***
......@@ -26,16 +26,17 @@
**Designed with care**
* **New in v4**: automatically ships with dark mode
+ Comes with a simple, focused, and extremely light design
+ Works not just on mobile, but also on the archaic Internet Explorer 8
+ Works not just on mobile, but also on the archaic Internet Explorer 8 for some reason
+ 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
+ Customizable views, colors, and other elements
+ Customizable views, colors, HTML, and other elements
**Fast, reliable, and free (even to host)**
+ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator
+ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/)
+ Secure, ready for HTTPS; see [JAMstack](https://jamstack.org/)
+ Easy to edit and deploy on Netlify for _absolutely free_
**Easy to setup, manage, use**
......@@ -43,7 +44,8 @@
+ Edit your status page from a simple config file
+ Comes pre-equipped with Netlify CMS for quick admin updates
+ Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki)
+ [Read-only API available](https://github.com/cstate/cstate/wiki/API)
+ You can not only create issues, but also informational, about pages
+ **New in v4**: [Read-only API available](https://github.com/cstate/cstate/wiki/API)
## Getting started 💻
......@@ -119,24 +121,28 @@ If you would like to commit/make a PR, make sure that `themesDir` is a comment b
## 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.
**If you are updating from one major version to another, like from v3 to v4, then please [read the migration guides](https://github.com/cstate/cstate/wiki/Usage#migration-guides).**
If you already have a Git repository set up with a filled up `themes/cstate` folder, then all you need to do is this:
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.
```bash
git submodule foreach git pull origin master
```
Ask yourself these questions:
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:
1. Do I already have the **up to date** Git repository with my status page on my computer?
* If not, go to your desktop or somewhere else, where you can download your Git repository and run: `git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master`.
* In the parent directory, type `hugo serve`. Check to see if everything is working.
* Then do `git add -A; git commit -m "Update cState"; git push origin master; exit`. Your status page is now updated.
2. If you **DO** have the directory, go inside `themes/cstate`. If that is empty, it is easier to delete your local copy and do the steps outlined earlier.
```bash
git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master
```
There is currently no easier way to do this, unfortunately, you will need the terminal / command line / Git Bash, unless you want to create a new status page from scratch and move your data over manually.
More info about submodules on [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules).
More info about submodules: [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules).
## FAQ 🤔
### Are there settings you can change?
Yes, most of the settings are in the `config.yml` file or under _Settings_ in Netlify CMS.
### Where do issues go?
#### Using an admin panel (Netlify CMS)
......@@ -178,24 +184,28 @@ Time to break that down.
Check out [the wiki](https://github.com/cstate/cstate/wiki).
## Donate ❤️
## Support ❤️
cState is only a hobby project of @mistermantas, but it has turned into something a little bit bigger.
Please **star, share, and use the software**. Thank you, if you do.
If you wish to support the project financially:
cState is only a hobby project of @mistermantas, but it’s a prideful one.
[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas)
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.
[Support the author on PayPal](https://www.paypal.me/mistermantas)
* [PayPal](https://paypal.me/AlbinaV}
* or you can make a bank transfer. For info, [get in touch](https://mnts.lt)
## Contribute 💥
> Want to become a maintainer? Hit me up! [@mistermantas](https://twitter.com/mistermantas)
> Want to become a maintainer? Hit me up [on Twitter @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.
+ Version numbers should be added in JS partial & meta generator tags!
+ Write consistent, simple, readable code, and precise documentation.
+ Version numbers should be added in the JS partial, the meta[generator] tag, and API index!
## License ✍
......
......@@ -5,8 +5,8 @@
{{ $isDown := where $active "Params.severity" "=" "down" }}
{
"is": "index",
"cStateVersion": "4.0",
"apiVersion": "1.0",
"cStateVersion": "4.0.0",
"apiVersion": "1.0.0",
"title": "{{ .Site.Title }}",
"languageCodeHTML": "{{ .Site.LanguageCode }}",
"languageCode": "{{ T "languageCode" }}",
......
......@@ -3,7 +3,7 @@
* Dev toolset
*/
console.log('cState v4.0.0 - Dev 2019-10-06 - https://github.com/cstate/cstate');
console.log('cState v4.0.0 - rc1 2019-12-15 - https://github.com/cstate/cstate');
document.getElementsByTagName('html')[0].className = 'js';
/**
......
......@@ -12,7 +12,7 @@
{{ range .AlternativeOutputFormats -}}
{{ printf `<link rel="%s" type="%s" href="%s" title="%s" />` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
{{ end -}}
<meta name="generator" content="cState v4.0.0 - Dev 2019-10-06">
<meta name="generator" content="cState v4.0.0 - rc1 2019-12-15 - https://github.com/cstate/cstate">
<meta name="theme-color" content="{{ .Site.Params.brand }}">
<script>
var themeBrandColor = '{{ .Site.Params.brand }}';
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment