Skip to content
Snippets Groups Projects
Commit fa1a786c authored by Dmytro Bogatov's avatar Dmytro Bogatov :two_hearts:
Browse files

Update docs.

parent f2406671
Branches
No related tags found
No related merge requests found
Pipeline #
......@@ -104,7 +104,7 @@ blc-docs:
- http-server documentation/out/ -p 8080 > /dev/null &
- sleep 5
script:
- blc --filter-level 3 --input http://localhost:8080 -rog --exclude "*linkedin.*" --exclude "*doxygen.*"
- blc --filter-level 3 --input http://localhost:8080 -rog --exclude "*linkedin.*" --exclude "*doxygen.*" --exclude "*status.dbogatov.org*"
tags:
- docker
......
# Badges
You may put badges on your websites or in your markdown documents.
!!! success "Badge example"
[![system health](https://status.dbogatov.org/health)](https://status.dbogatov.org/)
## Code
!!! warning
Use **your domain** instead of `https://status.dbogatov.org`
### Markdown
Here is how to put **system health** badge in markdown
[![system health](https://status.dbogatov.org/health)](https://status.dbogatov.org/)
Here is how to put **individual metric health** badge in markdown
[![metric health](https://status.dbogatov.org/health/type/source)](https://status.dbogatov.org/home/metric/type/source)
Where *type* is a metric type (eq. `cpuload`) and *source* is a metric source.
### HTML
Here is how to put **system health** badge in markdown
<a href="https://status.dbogatov.org/">
<img alt="system health" src="https://status.dbogatov.org/health" />
</a>
Here is how to put **individual metric health** badge in markdown
<a href="https://status.dbogatov.org/home/metric/type/source">
<img alt="metric health" src="https://status.dbogatov.org/health/type/source" />
</a>
Where *type* is a metric type (eq. `cpuload`) and *source* is a metric source.
......@@ -4,7 +4,7 @@
Status site is the application for monitoring the health of the servers and web services.
[![build status](https://git.dbogatov.org/dbogatov/status-site/badges/master/build.svg)](https://git.dbogatov.org/dbogatov/status-site/commits/master)
[![system health](https://status.dbogatov.org/home/health)](https://status.dbogatov.org/)
[![system health](https://status.dbogatov.org/health)](https://status.dbogatov.org/)
## Features
......
......@@ -71,6 +71,7 @@ pages:
- Development: development.md
- Deployment: deployment.md
- Configuration: configuration.md
- Badges: badges.md
- Documentation: documentation.md
- Server:
- Home: server/index.md
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment