diff options
Diffstat (limited to 'exampleSite')
-rw-r--r-- | exampleSite/config.yml | 124 | ||||
-rw-r--r-- | exampleSite/content/api.html | 6 | ||||
-rw-r--r-- | exampleSite/content/stats.html | 5 | ||||
-rw-r--r-- | exampleSite/layouts/README.md | 3 | ||||
-rw-r--r-- | exampleSite/netlify.toml | 14 | ||||
-rw-r--r-- | exampleSite/static/README.md | 9 | ||||
-rw-r--r-- | exampleSite/static/logo.png | bin | 0 -> 21758 bytes |
7 files changed, 103 insertions, 58 deletions
diff --git a/exampleSite/config.yml b/exampleSite/config.yml index f731012..c75c9b6 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -37,7 +37,7 @@ # What is your status page called? # Shows up in the browser bar and meta tags -title: Example Chat App Status +title: Example Status # What language is this page in? # Only alters the html[lang] attribute @@ -58,52 +58,71 @@ baseURL: / # +------------------------------------------------------+ # ############################################################ -# Should posts, which have a publish date -# from the future, be built? Useful for -# sharing upcoming maintenance, etc. -# -# We recommend to keep this at `true`. -# BOOLEAN; `true`, `false` -buildFuture: true - params: # These are your systems. Change them to # change the amount of components. + # + # For help, see the wiki: + # https://github.com/mistermantas/cstate/wiki/Customization systems: - #- - # name: Client Area - # codename: panel - #- - # name: Minecraft - # codename: mc - #- - # name: Web Hosting - # codename: web - - Gateway - - API - - Media Proxy + - + name: Gateway + - + name: API + description: The guts of the application. + - + name: Media Proxy + description: This is the service responsible for serving images, audio, and video. It is reliant on Fastly. + # partial: custom/metrics # What header design should we use? + # # Default: true # BOOLEAN; `true`, `false` useLargeHeaderDesign: false # Should we show the logo or the title # of the status page? - useLogo: false + # + # Default: false + # BOOLEAN; `true`, `false` + useLogo: true # Where is the logo located, if one is # present at all? # - # Recommended: png or jpg for best - # browser support! - # logo: /logo.png + # Recommended: png is best used for + # images like logos. + # + # Recommended: png, bmp, jpg, or gif + # for best browser support! + logo: /logo.png # This is the description that is shown # in the footer and meta tags. + # + # Default: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here. description: We continuously monitor the status of our services and if there are any interruptions, a note will be posted here. - # Cplors throughout cState + # Tabs on homepage + # Uncomment to enable. + # + # Format: + # customTabs: + # - + # name: Name + # link: https://example.com + + # Uptime statistics tab + # + # Shows link to /stats + # (uptime stats) + # + # Default: true + # BOOLEAN; `true`, `false` + showUptime: true + + # Colors throughout cState # # Defaults: # @@ -117,8 +136,6 @@ params: disrupted: FF8C00 down: DC143C notice: 708090 - border: dfdfdf - faded: ccc # If the status page shows that # there are disruptions or outages @@ -131,37 +148,20 @@ params: # BOOLEAN; `true`, `false` alwaysKeepBrandColor: true -############################################################ -# +------------------------------------------------------+ # -# | Developer | # -# +------------------------------------------------------+ # -############################################################ - - # Custom CSS file - # If you want to add any - # custom styling, you may - # link to one file with all - # your modifications here. - # - # This has *intentionally* - # been left uncommented, - # as it is not an advanced - # feature for developers. + # Google Analytics tracking code # - # customCSS: /custom.css - - # Custom JavaScript file - # If you want to add any - # custom scripting, you may - # link to one file with all - # your modifications here. + # By default, cState does not use + # Google Analytics. If you choose + # to use it, you may change the + # placeholder code below to your + # own and thereby enable the + # tracking service. # - # This has *intentionally* - # been left uncommented, - # as it is not an advanced - # feature for developers. + # To disable the analytics, change + # the value to the default: # - # customJS: /custom.js + # Default: UA-00000000-1 + googleAnalytics: UA-00000000-1 ############################################################ # +------------------------------------------------------+ # @@ -169,13 +169,21 @@ params: # +------------------------------------------------------+ # ############################################################ +# Should posts, which have a publish date +# from the future, be built? Useful for +# sharing upcoming maintenance, etc. +# +# We recommend to keep this at `true`. +# BOOLEAN; `true`, `false` +buildFuture: true + # These options affect the core of cState. # Please do not change them if you do not # know what you are doing. -theme: cstate +theme: cstate-dev # If you are developing locally and want # to contribute to the cState Git repo, # please uncomment this option but do not # forget to re-comment it when -# themesDir: ../.. +themesDir: ../.. diff --git a/exampleSite/content/api.html b/exampleSite/content/api.html new file mode 100644 index 0000000..bf2b338 --- /dev/null +++ b/exampleSite/content/api.html @@ -0,0 +1,6 @@ +--- +--- + +<!-- +Please keep this file if you wish to enable API access. +--> diff --git a/exampleSite/content/stats.html b/exampleSite/content/stats.html index d4dd1aa..bee2349 100644 --- a/exampleSite/content/stats.html +++ b/exampleSite/content/stats.html @@ -1,4 +1,9 @@ --- title: Uptime +description: This page has some information analyzing the downtime that has been reported on this status page. type: uptime --- + +<!-- +Please keep this file if you wish to show uptime stats. +--> diff --git a/exampleSite/layouts/README.md b/exampleSite/layouts/README.md new file mode 100644 index 0000000..61e8a98 --- /dev/null +++ b/exampleSite/layouts/README.md @@ -0,0 +1,3 @@ +This folder can be used to overwrite or add any layouts to your status page. + +For more, please [read the documentation](https://github.com/mistermantas/cstate/wiki/Customization). diff --git a/exampleSite/netlify.toml b/exampleSite/netlify.toml new file mode 100644 index 0000000..3ef9150 --- /dev/null +++ b/exampleSite/netlify.toml @@ -0,0 +1,14 @@ +[build] + command = "hugo" + publish = "public" + functions = "functions" + +[build.environment] + HUGO_VERSION = "0.41" + +[context.production.environment] + HUGO_ENV = "production" + NODE_ENV = "production" + +[context.deploy-preview] + command = "hugo" diff --git a/exampleSite/static/README.md b/exampleSite/static/README.md new file mode 100644 index 0000000..7541621 --- /dev/null +++ b/exampleSite/static/README.md @@ -0,0 +1,9 @@ +This folder can be used to store any static content that you may want to link to on your status page. + +You may replace the default favicons by creating icons with these names: + +- favicon-16x16.png +- favicon-32x32.png +- favicon.ico + +You may also replace the Netlify CMS configuration by creating an `admin` folder and placing your own `config.yml` or `index.html` file by following the project's given instructions. diff --git a/exampleSite/static/logo.png b/exampleSite/static/logo.png Binary files differnew file mode 100644 index 0000000..851d104 --- /dev/null +++ b/exampleSite/static/logo.png |