Fix markdown issue

Markdown is tested on Dillinger.io and the interpreter is not exactly
the same as the one on Github, so I fix the Markdown to be more
readable.
This commit is contained in:
Anthony Bocci 2018-06-22 21:57:51 +02:00
parent 33ef9753fb
commit 83d22e957b
6 changed files with 16 additions and 20 deletions

View File

@ -1,6 +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
@ -24,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.

View File

@ -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.

View File

@ -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].

View File

@ -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:
@ -13,5 +13,6 @@ You may configure your Cachet installation for CORS very easily. To blacklist ev
- You'll see a Allowed domains textarea, fill in any domains that you
want to access the API as a comma separated list:
> _Text_
> https://demo.cachethq.io,https://status.cachethq.io
```
https://demo.cachethq.io,https://status.cachethq.io
```

View File

@ -4,8 +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.
@ -35,14 +34,12 @@ 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.
@ -61,8 +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.
@ -81,8 +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/*`
@ -90,8 +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`

View File

@ -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]