Commit 2122c81e authored by Alexandr Musikhin's avatar Alexandr Musikhin

Update README.md

parent 9cc4d7a2
Pipeline #22212512 passed with stage
in 2 minutes and 25 seconds
# tophackr status
## How to modify files to your own status
## About
In config ([_config.yml]) you need to change this line to your own.
```
title: example status
description: example description to site
baseurl: '/status' # if you want to connect your own domain to the status of the quotation marks leave blank or remove this line.
url: 'https://example.com'
repository: 'https://example.gitlab.com/example-name/example-project'
email: admin@example.com
twitter: examplestatus
```
and you need to change `zone` to your timezone, and `timezone`. A list of all available values can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
```
zone: 'UTC+3' # example
timezone: Europe/Moscow # example
```
## How to create incident
There are 3 types of incident [danger], [warning], [success].
You can use these drafts as you want, just note that the history displays danger incident.
Posts need to be created in the folder [_posts]
## Schedules
You must also create a [scheduler](https://gitlab.com/tophackr/status/pipeline_schedules), to update the status of the site every day itself without incident.
```
Description: Update status
Interval Pattern:
Custom:
- 0 0 * * *
Cron Timezone: Your time zone which is specified in _config
```
This repository is created to track tophackr services.
You can also make a fork of this project for your own purposes, before that read the installation [guide].
## If you have a problem
Check [repository page][repository] or [status page][status]
[_config.yml]: _config.yml
[danger]: _drafts/danger.md
[warning]: _drafts/warning.md
[success]: _drafts/success.md
[_posts]: _posts/
[guide]: CONTRIBUTING.md
[repository]: https://gitlab.com/tophackr/status
[status]: https://status.tophackr.com
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment