diff --git a/docs/api/api-authentication.md b/docs/api/api-authentication.md index d3e02f3e..f2e49724 100644 --- a/docs/api/api-authentication.md +++ b/docs/api/api-authentication.md @@ -20,7 +20,7 @@ When making any request to the API which is not a `GET`, you'll need to use some kind of authentication. The simplest of the authorization methods offered by Cachet is [BasicAuth][1]. -> **This is not secure** +> **This is not secure** > For obvious reasons, sending your authentication details in plain text is not > secure. We do advise that you add SSL to your Cachet installation for added > security, but suggest using API tokens. diff --git a/docs/faq.md b/docs/faq.md index 422487d4..42a8eb1a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -62,7 +62,7 @@ promise that your support request will be dealt with immediately. ### Why isn't the _Subscribe_ button enabled? Cachet checks some informations before displaying the _Subscribe_ button, -because checking the "Enable subscribers" is not enough. +because checking the "Enable subscribers" is not enough. To see the _Subscribe_ button you need to: - Check the box "Enable subscribers" in the settings. diff --git a/docs/incidents/index.md b/docs/incidents/index.md index 1e56a310..ea5636c1 100644 --- a/docs/incidents/index.md +++ b/docs/incidents/index.md @@ -5,13 +5,13 @@ An incident is something that should not happen, but that happens anyway. ## What is exactly an incident In your status page you are showing the state of some components. It may be a -server, a database, of whatever you want. +server, a database, of whatever you want. If your database server crashes, it is an incident. ## Why should I create an incident Having a status page is a good thing, being honest with the state of your -components is better. +components is better. A status page is not only there to show a green light, it's also there to show why something bad is happening, and when it will be fixed. @@ -21,7 +21,7 @@ incident. ## How to use the incidents When experiencing an incident, it's good to keep being up-to-date with what -happens in the real world. That's why you can use _incident updates_. +happens in the real world. That's why you can use _incident updates_. How you manage your incidents is up to you, but if you have no idea you can do the following: diff --git a/docs/metrics/create-metric.md b/docs/metrics/create-metric.md index 71224302..b0615a7b 100644 --- a/docs/metrics/create-metric.md +++ b/docs/metrics/create-metric.md @@ -1,6 +1,6 @@ # Create a metric -This documentation will guide you through the metric creation. +This documentation will guide you through the metric creation. You need to know [what is a metric][1]. ## Filling the form @@ -14,7 +14,7 @@ To access to the metrics creation, follow these steps: - Once on the Dashboard click `Metrics` in the sidebar. - Click the `Create a metric` button. -And you are there! You should be able to see the metric form. +And you are there! You should be able to see the metric form. Let's explain the fields: - `Name`: The name of the metric as it will be shown on the status page. diff --git a/docs/metrics/index.md b/docs/metrics/index.md index 247cb6c3..6efd6764 100644 --- a/docs/metrics/index.md +++ b/docs/metrics/index.md @@ -14,11 +14,11 @@ about what you are monitoring to Cachet. ## What can do metrics for you -Having good metrics to show may be great for customers or partners. +Having good metrics to show may be great for customers or partners. You have a big webservice that is under pressure? So it's important to have a short response time. A metric could show to your users that the webservice is -responding fast! +responding fast! Imagine, you have a metric named "Response time". Every 10 seconds you call your webservice, and send the response time to the Cachet's API, in the metric. On your status page you'll be able to see the average response time for a minute diff --git a/docs/setup/beacons.md b/docs/setup/beacons.md index d686a1bd..08d5aeb3 100644 --- a/docs/setup/beacons.md +++ b/docs/setup/beacons.md @@ -1,7 +1,7 @@ # Beacons > **Version Support** -> +> > Beacons will be introduced in v2.4.0 Cachet will periodically communicate with our remote server. This is done so @@ -25,7 +25,7 @@ We report the following information to our server: - A support contact email (the first enabled admin's email) - Anonymous statistics (the number of users, incidents, components and metrics) -> **Support Contact Email** +> **Support Contact Email** > The contact email is used for the sole purpose of security > announcements and will never be used for anything else. diff --git a/docs/setup/configuring-queue.md b/docs/setup/configuring-queue.md index d1bcf766..2fe7d2f9 100644 --- a/docs/setup/configuring-queue.md +++ b/docs/setup/configuring-queue.md @@ -39,7 +39,7 @@ autorestart=true user=cachet ``` -> **Update to your configuration!** +> **Update to your configuration!** > Be sure to update the values in the example configuration above to match > your installation setup. diff --git a/docs/setup/configuring-subscribers.md b/docs/setup/configuring-subscribers.md index 96802f7e..3c1030a9 100644 --- a/docs/setup/configuring-subscribers.md +++ b/docs/setup/configuring-subscribers.md @@ -6,7 +6,7 @@ One of the most powerful features of Cachet is the ability to automatically send notification emails to anybody who has subscribed to your status page whenever an incident is created. -> **Hold up!** +> **Hold up!** > Before going any further, ensure that you've [configured > the mail][1] and the [queue][2]. diff --git a/docs/setup/cors.md b/docs/setup/cors.md index 03ef5fbd..6e29dc80 100644 --- a/docs/setup/cors.md +++ b/docs/setup/cors.md @@ -2,7 +2,7 @@ Cross-original resource sharing -> **External Access** +> **External Access** > By default Cachet can be accessed by any third-party server. You may configure your Cachet installation for CORS very easily. To blacklist everybody except one or more domains: diff --git a/docs/setup/installation.md b/docs/setup/installation.md index 2db63b30..b05a2fe8 100644 --- a/docs/setup/installation.md +++ b/docs/setup/installation.md @@ -4,7 +4,7 @@ This guide will detail how to install Cachet on your server. ## Download the source code with Git -> **Check out the latest version!** +> **Check out the latest version!** > The tags below are examples of what will be shown. > You should always run git checkout on the latest tag. @@ -34,19 +34,19 @@ file to `.env` regardless of what environment you're working on. It's now just a case of editing this new .env file and setting the values of your setup. -> **Environment Configuration Notice** +> **Environment Configuration Notice** > Any values with spaces in them should be contained within double quotes. The `.env` file set environment variables that will be used by the application. -> **SQLite hosts** +> **SQLite hosts** > If you're using SQLite then your .env file should not contain a > `DB_HOST` key. You'll also need to touch ./database/database.sqlite > and give it the required permissions. ## Installing Composer -Cachet uses dependencies, so it's required to have Composer installed. +Cachet uses dependencies, so it's required to have Composer installed. Composer can be installed following the [official guide][1] ## Installing dependencies @@ -58,7 +58,7 @@ composer install --no-dev -o If you are installing Cachet as a contributor, you can forget the `--no-dev` option. -> **Tip for Windows users** +> **Tip for Windows users** > If you're stuck at the Composer stage, you can run > `composer install --no-dev -o --no-scripts` > which usually fixes any issues on Windows servers. @@ -77,7 +77,7 @@ php artisan app:install > Never change the `APP_KEY` after installation on production environment. > This will result in all of your encrypted/hashed data being lost. -> **Getting a 500 - Internal Server Error?** +> **Getting a 500 - Internal Server Error?** > If you get a 500 error when visiting your status page, you may need to > run `chmod -R 777 storage/` for it to work or `rm -rf bootstrap/cache/*` @@ -85,7 +85,7 @@ You can also try to give permissions to cache chmod -R 777 bootstrap/ ## Running Cachet on Apache -> **Required Apache Modules** +> **Required Apache Modules** > You need to enable `mod_rewrite` for Apache. On Debian-based systems you can do this by > > `sudo a2enmod rewrite` @@ -95,13 +95,13 @@ new Virtual Host entry in the httpd-vhosts.conf file. ``` - ServerName cachet.dev + ServerName cachet.dev # Or whatever you want to use - ServerAlias cachet.dev + ServerAlias cachet.dev # Make this the same as ServerName DocumentRoot "/var/www/Cachet/public" - Require all granted + Require all granted # Used by Apache 2.4 Options Indexes FollowSymLinks AllowOverride All @@ -117,7 +117,7 @@ Restart Apache by running the following: If you also need HTTPS on apache you will need to get the ssl mod installed -and the default ssl conf file enabled. See DigitalOcean's [documentation][2]. +and the default ssl conf file enabled. See DigitalOcean's [documentation][2]. ## Running Cachet on nginx diff --git a/docs/setup/prerequisites.md b/docs/setup/prerequisites.md index faf2052a..899883a4 100644 --- a/docs/setup/prerequisites.md +++ b/docs/setup/prerequisites.md @@ -13,11 +13,11 @@ You'll need at least the following installed on your server: - A database driver for your DB, such as MySQL, PostgreSQL or SQLite. - Git -> **SQLite** +> **SQLite** > Whilst we support SQLite, we advise not using it for status pages > with a high amount of traffic. -> **MySQL Timezone Info** +> **MySQL Timezone Info** > Ensure your MySQL database has been updated with the correct timezone > information. This will ensure that metrics are shown > correctly: [https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html][2]