From 9ba5e70df5014215340dc01e054f66a021ed1bd1 Mon Sep 17 00:00:00 2001 From: HyRo Date: Tue, 3 Nov 2020 07:28:59 +0100 Subject: Added "Hyrousek" status page --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 795ced5..40c9ae6 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ You can also support the creator of this project by **starring, sharing, and usi * [Content Ignite](https://status.contentignite.com/) * [FSCI](https://status.fsci.in/) * [Storehouse](https://status.sthse.co) +* [Hyrousek](https://status.hyrousek.tk) *Want your status page here? [Create a PR](https://github.com/cstate/cstate/edit/dev/README.md)!* -- cgit v1.2.3-70-g09d2 From f191b32b505516036ed01fcafacaee8a980308a8 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sat, 28 Nov 2020 15:55:19 +0200 Subject: Netlify mention --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 40c9ae6..5f3a1df 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ You can also support the creator of this project by **starring, sharing, and usi * [**Example site — cstate.mnts.lt**](https://cstate.mnts.lt) * [Source code of the example cState site](https://github.com/cstate/example) +*Thank you to [Netlify](https://www.netlify.com) for hosting our demo websites!* + ### More examples from the internet * [Chocolatey](https://status.chocolatey.org/) -- cgit v1.2.3-70-g09d2 From 9320bf6ea46be7c3a3e3a54ce179e4809cb83771 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sun, 21 Feb 2021 18:53:07 +0200 Subject: forestry/vercel --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5f3a1df..8021cb7 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ You can [make Netlify CMS work on GitLab](https://www.netlifycms.org/docs/gitlab #### 🖤 Other platforms -At this time, as of the author's knowledge, there are no other platforms that support 'easy' deployment (if you know any — [let us know](#contribute-)). +Check out [Forestry.io](//forestry.io) and [Vercel](//vercel.com). Keep reading to see how to deploy manually. -- cgit v1.2.3-70-g09d2 From 867f6a5dc8118d0d6f903eea75484c59e296d37e Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sun, 21 Feb 2021 18:54:56 +0200 Subject: Remove twitter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8021cb7..6901d04 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

cState example illustration

-

GitHub release GitHub last commit GitHub repo size in bytes Discord Chat Twitter Awesome status page

+

GitHub release GitHub last commit GitHub repo size in bytes Discord Chat Awesome status page

> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify. Comes with Netlify CMS, read-only API, and other useful features. -- cgit v1.2.3-70-g09d2 From 63c8b6d379d7311079555c49a9b3003fd41723c2 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Wed, 24 Feb 2021 17:09:25 +0200 Subject: Automatic monitoring not possible --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 6901d04..ad667cc 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,8 @@ There are other commercial options that may update faster because of their archi ### List of possibilities +**Please note that with all that cState _can_ do, it cannot do automatic monitoring. [See this thread](https://github.com/cstate/cstate/issues/124)** + | **cState is designed with care** | **Fast, reliable, and free (even with host)** | **Easy to setup, manage, use** | |-------------------------------------------------------------------------------------------------------------------------- |-------------------------------------------------------------------------------------------------------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------- | | A simple and focused user interface & experience with [instant loading](https://github.com/cstate/cstate/issues/117), suitable for any brand | Built with [Hugo](https://gohugo.io), a hyperfast Golang static site generator (SSG) | As easy as WordPress: if you don't like getting into the code, try Netlify CMS | -- cgit v1.2.3-70-g09d2 From a69adf3be547f602c6fc6d6c4ee71a8073645a96 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sat, 6 Mar 2021 16:23:24 +0200 Subject: Improve README --- README.md | 96 ++++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 52 insertions(+), 44 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ad667cc..b31a1fd 100644 --- a/README.md +++ b/README.md @@ -74,10 +74,9 @@ There are other commercial options that may update faster because of their archi ## Getting started 💻 This is how you create a **new site powered by cState.** What you are generating is a Hugo site with specific, already existing modifications (to Hugo, cState is a theme). + -### — The easy way — - -#### 💚 Netlify and Netlify CMS +### 💚 Netlify and Netlify CMS cState was built to work best with Netlify and comes with the neccesary files to enable Netlify CMS. @@ -102,38 +101,49 @@ These are the settings you should be using: + Publish directory: **public** + Add one build environment variable + Key: **HUGO_VERSION** - + Value: **0.48** (or later) + + Value: **0.80** (or later) ++ Also **for the Build image selection, pick Ubuntu Xenial 16.04 or later** +### 🧡 Other great hosting and CMS options -#### 🧡 GitLab Pages (Experimental) +The most popular options, apart from Netlify's offers, are: -GitLab Pages, unlike GitHub Pages, supports Hugo, so you can let GitLab build and serve cState without needing to do it on your own machine ([similarly to how you can blog with GitLab Pages from your phone](https://about.gitlab.com/blog/2016/08/19/posting-to-your-gitlab-pages-blog-from-ios/)). +* **Hosting:** + * GitHub Pages + * GitLab Pages + * CloudFlare Pages + * Vercel +* **Admin panels / CMS:** + * Forestry.io + * Or just use your Git provider (github.com, gitlab.com, etc) -[GitLab has a good guide for getting started with GitLab Pages in their documentation.](https://docs.gitlab.com/ee/user/project/pages/#getting-started) +You can also look at [other headless CMS options **(we use Git-based CMS types)** on jamstack.org](https://jamstack.org/headless-cms/). -**In short: a `.gitlab-ci.yml` file** is responsible for making cState work. As of v4.2.1, the [cState automatically ships with this file](https://github.com/cstate/cstate/releases/tag/v4.2.1). +### GitLab Pages -As of this time, this is a relatively untested option, but Hugo does seem to generate the right things (this can be checked by downloading the **CI/CD artificats**). +Here is a [good guide for getting started with the service.](https://docs.gitlab.com/ee/user/project/pages/#getting-started) -According to GitLab, it may take up to 30 minutes before the site is available after the first deployment. +**In short: a `.gitlab-ci.yml` file** is responsible for making cState work. As of v4.2.1, the [cState automatically ships with this file](https://github.com/cstate/cstate/releases/tag/v4.2.1), but support is still experimental. -You can [make Netlify CMS work on GitLab](https://www.netlifycms.org/docs/gitlab-backend/), but that requires overriding an existing file in the theme. Create a file in `static/admin/config.yml` and follow the instructions linked earlier. (cState by default ships with Git Gateway.) +As of this time, this is a relatively untested option, but Hugo does seem to generate the right things (this can be checked by downloading the **CI/CD artificats**). +According to GitLab, it may take up to 30 minutes before the site is available after the first deployment. -#### 🖤 Other platforms +You can [make Netlify CMS work on GitLab](https://www.netlifycms.org/docs/gitlab-backend/), but that requires overriding an existing file in the theme. Create a file in `static/admin/config.yml` and follow the instructions linked earlier. (cState by default ships with Git Gateway for Netlify.) -Check out [Forestry.io](//forestry.io) and [Vercel](//vercel.com). +### GitHub Pages, CloudFlare Pages, Vercel, Forestry, and others -Keep reading to see how to deploy manually. +There is no official, separate documentation for these, but if you look below to see how to deploy manually, the instructions will be the same everywhere. +### Doing it on your PC +Keep reading to see how to deploy manually. Developers wishing to contribute, scroll to the very bottom. -### — Manual builds — +### Manual builds 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. - +> A minimum version of `0.80` is required for Hugo, starting with v5. #### I want to use my site in production @@ -161,30 +171,6 @@ And the folder `public` can now be hosted. The downside with manual building is that, if you do not want to use a solution like GitLab Pages or Netlify, this process will need to happen on your computer. This can be tedious. - -#### I want to contribute to the development - -1. Clone this repository in the command line: - -```bash -git clone --recursive -b master https://github.com/cstate/cstate.git -``` - -2. Navigate to the theme directory: - -```bash -cd cstate/exampleSite -``` - -3. Launch the development setup like this: - -```bash -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 making a PR. - - ### — Docker — cState comes with a Dockerfile and Netlify ([according to their article from 2016](https://www.netlify.com/blog/2016/10/18/how-our-build-bots-build-sites/)) uses a similar Docker system to build cState. This is an option for people who prefer Docker and NGINX instead of serverless, but serverless still has the priority in our development. @@ -280,15 +266,37 @@ Check out [the wiki](https://github.com/cstate/cstate/wiki). ## Contribute 💥 -**Making a change in the code** +### Making a change in the code PRs should be submitted to the `dev` branch, if it exists. Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues). -**For translators** +Here is a guide for how you should develop: + +1. Clone this repository in the command line: + +```bash +git clone --recursive -b master https://github.com/cstate/cstate.git +``` + +2. Navigate to the theme directory: + +```bash +cd cstate/exampleSite +``` + +3. Launch the development setup like this: + +```bash +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 making a PR. + +### For translators [See this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations). -**Code of conduct** +### Code of conduct [Be kind](/CODE_OF_CONDUCT.md). -- cgit v1.2.3-70-g09d2 From 730ffa6e49d6758134ae2c140f561c7a97ff9dd2 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sat, 6 Mar 2021 17:34:29 +0200 Subject: Clean up README --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b31a1fd..43812a8 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,12 @@ -

cState example illustration

- -

GitHub release GitHub last commit GitHub repo size in bytes Discord Chat Awesome status page

+

cState example illustration

> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify. Comes with Netlify CMS, read-only API, and other useful features. -## Sponsors 🏅 - -Statuspal +GitHub last commit Awesome status page -You can also support the creator of this project by **starring, sharing, and using cState**. Thank you! +Sponsored by Statuspal -[*Learn more about sponsorships*](https://github.com/sponsors/mistermantas) +You can also support the creator of this project by **starring, sharing, using cState and/or [financially supporting the author](https://github.com/sponsors/mistermantas)**. Thank you! ## Examples 🥳 @@ -19,8 +15,6 @@ You can also support the creator of this project by **starring, sharing, and usi * [**Example site — cstate.mnts.lt**](https://cstate.mnts.lt) * [Source code of the example cState site](https://github.com/cstate/example) -*Thank you to [Netlify](https://www.netlify.com) for hosting our demo websites!* - ### More examples from the internet * [Chocolatey](https://status.chocolatey.org/) -- cgit v1.2.3-70-g09d2 From ad77f48b3beb3407e4bafedb93076291a61111c2 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sat, 6 Mar 2021 17:36:08 +0200 Subject: cleanup --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 43812a8..346a1ab 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,7 @@ And the folder `public` can now be hosted. The downside with manual building is that, if you do not want to use a solution like GitLab Pages or Netlify, this process will need to happen on your computer. This can be tedious. -### — Docker — +### Docker cState comes with a Dockerfile and Netlify ([according to their article from 2016](https://www.netlify.com/blog/2016/10/18/how-our-build-bots-build-sites/)) uses a similar Docker system to build cState. This is an option for people who prefer Docker and NGINX instead of serverless, but serverless still has the priority in our development. @@ -296,7 +296,7 @@ The main directory is the theme itself (the cState guts, basically) and the `exa ## License ✍ -[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://mnts.lt) +[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://vilcinskas.me) A special thanks to all [the contributors](https://github.com/cstate/cstate/graphs/contributors) -- cgit v1.2.3-70-g09d2 From 7aac467a98762e9c717ff04c4c62833ae454b911 Mon Sep 17 00:00:00 2001 From: Josh Miles <19347018+notjoshmiles@users.noreply.github.com> Date: Mon, 8 Mar 2021 12:16:04 +0000 Subject: Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 346a1ab..2b7af8c 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ You can also support the creator of this project by **starring, sharing, using c * [FSCI](https://status.fsci.in/) * [Storehouse](https://status.sthse.co) * [Hyrousek](https://status.hyrousek.tk) +* [josh.win](https://status.josh.win) *Want your status page here? [Create a PR](https://github.com/cstate/cstate/edit/dev/README.md)!* @@ -105,7 +106,7 @@ The most popular options, apart from Netlify's offers, are: * **Hosting:** * GitHub Pages * GitLab Pages - * CloudFlare Pages + * Cloudflare Pages * Vercel * **Admin panels / CMS:** * Forestry.io @@ -125,7 +126,7 @@ According to GitLab, it may take up to 30 minutes before the site is available a You can [make Netlify CMS work on GitLab](https://www.netlifycms.org/docs/gitlab-backend/), but that requires overriding an existing file in the theme. Create a file in `static/admin/config.yml` and follow the instructions linked earlier. (cState by default ships with Git Gateway for Netlify.) -### GitHub Pages, CloudFlare Pages, Vercel, Forestry, and others +### GitHub Pages, Cloudflare Pages, Vercel, Forestry, and others There is no official, separate documentation for these, but if you look below to see how to deploy manually, the instructions will be the same everywhere. -- cgit v1.2.3-70-g09d2