From f8724ac3c615bf8e20f4bce79d6047ddf141a36c Mon Sep 17 00:00:00 2001 From: James Brooks Date: Sun, 28 Dec 2014 23:50:14 +0000 Subject: [PATCH 1/5] Begin writing some documentation --- docs/api/making-requests.md | 6 ++++++ docs/index.md | 8 ++++++++ docs/intro/index.md | 9 +++++++++ 3 files changed, 23 insertions(+) create mode 100644 docs/intro/index.md diff --git a/docs/api/making-requests.md b/docs/api/making-requests.md index 18f22c14..facc4486 100644 --- a/docs/api/making-requests.md +++ b/docs/api/making-requests.md @@ -1 +1,7 @@ # Making requests + +## Endpoint + +## Authorization + +## Security diff --git a/docs/index.md b/docs/index.md index 6eda30e0..c459849f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,13 @@ # Cachet Documentation +Cachet is an open source alternative to StatusPage.io written in PHP 5 with the Laravel 4.2 framework. + ## Table of contents +### Introduction + +- [Introduction to Cachet](/docs/intro/index.md) + ### API + +- [Cachet API](/docs/api/index.md) diff --git a/docs/intro/index.md b/docs/intro/index.md new file mode 100644 index 00000000..32438873 --- /dev/null +++ b/docs/intro/index.md @@ -0,0 +1,9 @@ +# Introduction to Cachet + +This document is a brief breakdown of what Cachet is, why it was built and how it works. Each section is explained in more detail within other pages. + +## What is Cachet? + +## Why build it? + +## How does it work? From 01e77b87b3a5a0fc66300f55ea30ec9d60747fba Mon Sep 17 00:00:00 2001 From: James Brooks Date: Sun, 28 Dec 2014 23:51:25 +0000 Subject: [PATCH 2/5] Rename index.md to readme.md for GitHub auto viewing --- docs/api/{index.md => readme.md} | 0 docs/intro/{index.md => readme.md} | 0 docs/{index.md => readme.md} | 4 ++-- 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/api/{index.md => readme.md} (100%) rename docs/intro/{index.md => readme.md} (100%) rename docs/{index.md => readme.md} (67%) diff --git a/docs/api/index.md b/docs/api/readme.md similarity index 100% rename from docs/api/index.md rename to docs/api/readme.md diff --git a/docs/intro/index.md b/docs/intro/readme.md similarity index 100% rename from docs/intro/index.md rename to docs/intro/readme.md diff --git a/docs/index.md b/docs/readme.md similarity index 67% rename from docs/index.md rename to docs/readme.md index c459849f..3bb3799b 100644 --- a/docs/index.md +++ b/docs/readme.md @@ -6,8 +6,8 @@ Cachet is an open source alternative to StatusPage.io written in PHP 5 with the ### Introduction -- [Introduction to Cachet](/docs/intro/index.md) +- [Introduction to Cachet](/docs/intro/readme.md) ### API -- [Cachet API](/docs/api/index.md) +- [Cachet API](/docs/api/readme.md) From 79b58f18e4e7de421cd0b5041646581171bcd040 Mon Sep 17 00:00:00 2001 From: James Brooks Date: Sun, 28 Dec 2014 23:53:24 +0000 Subject: [PATCH 3/5] Add setup and dashboard --- docs/dashboard/readme.md | 1 + docs/readme.md | 8 ++++++++ docs/setup/readme.md | 1 + 3 files changed, 10 insertions(+) create mode 100644 docs/dashboard/readme.md create mode 100644 docs/setup/readme.md diff --git a/docs/dashboard/readme.md b/docs/dashboard/readme.md new file mode 100644 index 00000000..c451e09d --- /dev/null +++ b/docs/dashboard/readme.md @@ -0,0 +1 @@ +# Dashboard overview diff --git a/docs/readme.md b/docs/readme.md index 3bb3799b..f25d5f60 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -8,6 +8,14 @@ Cachet is an open source alternative to StatusPage.io written in PHP 5 with the - [Introduction to Cachet](/docs/intro/readme.md) +### Setup + +- [Setting up Cachet](/docs/setup/readme.md) + +### Dashboard + +- [Dashboard overview](/docs/dashboard/readme.md) + ### API - [Cachet API](/docs/api/readme.md) diff --git a/docs/setup/readme.md b/docs/setup/readme.md new file mode 100644 index 00000000..c95ce085 --- /dev/null +++ b/docs/setup/readme.md @@ -0,0 +1 @@ +# Setting up Cachet From 4653d847abbdc117be38c400ba44f1700c33c13d Mon Sep 17 00:00:00 2001 From: James Brooks Date: Mon, 29 Dec 2014 00:10:38 +0000 Subject: [PATCH 4/5] Finish writing introduction to Cachet --- docs/intro/readme.md | 46 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/intro/readme.md b/docs/intro/readme.md index 32438873..15d3c618 100644 --- a/docs/intro/readme.md +++ b/docs/intro/readme.md @@ -4,6 +4,52 @@ This document is a brief breakdown of what Cachet is, why it was built and how i ## What is Cachet? +Cachet is a status page used for informing your customers/employees/developers with any updates or issues affecting your service and the individual components which make it up. + +For example, if you're running an online store, you may have the following components powering it: + +- Stripe (payments) +- Storefront (website) +- CDN +- API + +If your API breaks, developers may want to know what's going on as their integrations will have broken. You can easily update the status of the component and then create a new incident explaining the issue. As you progress through to rectifying the issue you can create more incidents with a new status. Eventually you'll have fixed the issue and your service status banner will turn green. + ## Why build it? +Originally built by [James Brooks](http://james-brooks.uk/cachet/), Cachet was a solution to a problem. Whilst there was [StatusPage.io](https://statuspage.io), it's an expensive service for the [small service](http://anorakci.com) that was being built at the time. + +Since Cachet is open source, **anybody** can run it and anybody can contribute to it. Contributions make software better and having the freedom to fork and improve upon it means it'll be forever improving. + ## How does it work? + +Cachet is built upon two core concepts: + +- [Components](#components) +- [Incidents](#incidents) + +Here we'll break down these concepts and how they work together. Cachet also uses metrics, however they're an optional feature of Cachet that can be unused without affecting anything. + +### Components + +A component is setup for each of the core, individual parts to a service or product, for instance; + +- API +- Website +- CDN +- Payments + +In the future Cachet will be able to create third-party components directly for things like: + +- GitHub +- Stripe +- Intercom +- Desk.com + +And automatically update the status based on their current service status. + +### Incidents + +Incidents are individual to components but come pre-designed to be linked against one of them, this background feature is ready for third-party components which will be coming later on. + +An incident is a status update containing a title, message and readable status. From d0e4a84f16143239dfb5b86c38cd53e0539263c2 Mon Sep 17 00:00:00 2001 From: James Brooks Date: Tue, 30 Dec 2014 10:43:37 +0000 Subject: [PATCH 5/5] Added some empty documents for creating components and incidents --- docs/dashboard/creating-components.md | 2 ++ docs/dashboard/creating-incidents.md | 2 ++ docs/readme.md | 2 ++ 3 files changed, 6 insertions(+) create mode 100644 docs/dashboard/creating-components.md create mode 100644 docs/dashboard/creating-incidents.md diff --git a/docs/dashboard/creating-components.md b/docs/dashboard/creating-components.md new file mode 100644 index 00000000..47f8c057 --- /dev/null +++ b/docs/dashboard/creating-components.md @@ -0,0 +1,2 @@ +# Creating components + diff --git a/docs/dashboard/creating-incidents.md b/docs/dashboard/creating-incidents.md new file mode 100644 index 00000000..dec84147 --- /dev/null +++ b/docs/dashboard/creating-incidents.md @@ -0,0 +1,2 @@ +# Creating incidents + diff --git a/docs/readme.md b/docs/readme.md index f25d5f60..c6adb240 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -15,6 +15,8 @@ Cachet is an open source alternative to StatusPage.io written in PHP 5 with the ### Dashboard - [Dashboard overview](/docs/dashboard/readme.md) +- [Creating components](/docs/dashboard/creating-components.md) +- [Creating incidents](/docs/dashboard/creating-incidents.md) ### API