Skip to content

Commit 281a876

Browse files
committed
Add Readthedocs sphinx build action
1 parent 9cc8525 commit 281a876

File tree

5 files changed

+43
-12
lines changed

5 files changed

+43
-12
lines changed

.github/workflows/doc-build.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: documentation-build
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
tags:
8+
- 'v*.*.*'
9+
release:
10+
types: [published]
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
env:
15+
working-directory: ./docs
16+
steps:
17+
- uses: actions/checkout@v3
18+
- name: Build docs
19+
run: |
20+
cd docs
21+
pip3 install -r requirements.txt
22+
make clean
23+
# Fail buiild on any docs warning
24+
make html O=-W
Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,30 @@
11
# Customization
22

3+
## Grafana Customization
34
```{include} custom-dashboards.md
4-
:heading-offset: 1
5+
:heading-offset: 2
56
```
67

8+
```{include} alerts-customization.md
9+
:heading-offset: 2
10+
```
11+
12+
## Prometheus Customization
713
```{include} custom-prometheus-configs.md
8-
:heading-offset: 1
14+
:heading-offset: 2
15+
```
16+
```{include} blackbox-exporter-config.md
17+
:heading-offset: 2
918
```
1019

1120

1221
```{toctree}
1322
:titlesonly:
1423
:hidden:
1524
16-
custom-prometheus-configs.md
17-
custom-dashboards.md
25+
custom-prometheus-configs
26+
custom-dashboards
27+
alerts-customization
28+
blackbox-exporter-config
1829
1930
```

docs/observability/customization/alerts-customization.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,3 @@ To define additional alert rules, create files in:
4040

4141
Grafana will automatically load these at startup.
4242

43-
---
44-

docs/observability/customization/blackbox-exporter-config.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
To define how a probe behaves (e.g., add basic auth, headers, timeout, method), we will configure a module in the Blackbox Exporter config.
66

7-
#### Create a Blackbox Exporter Config file
7+
### 1. Create a Blackbox Exporter Config file
88
You will need to create a new file, and then mount it over the existing provided vconfig
99

1010

@@ -51,7 +51,7 @@ This example adds a module named `http_2xx_custom` that adds some basic auth cre
5151

5252
---
5353

54-
#### Reference the new module in your prober config
54+
### 2. Reference the new module in your prober config
5555

5656
In your probe YAML file, reference the module in the `module` field of the `labels` section:
5757

@@ -63,7 +63,7 @@ In your probe YAML file, reference the module in the `module` field of the `labe
6363
module: http_2xx_custom # Optional - overrides the default Blackbox module
6464
```
6565

66-
#### Mount the config file
66+
### 3. Mount the config file
6767
You lastly need to mount the new config file and refer to it in docker compose
6868

6969
```
@@ -77,5 +77,3 @@ You lastly need to mount the new config file and refer to it in docker compose
7777
command:
7878
- "--config.file=/config/custom-blackbox-config.yml"
7979
```
80-
81-
---

docs/observability/setup/production-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Production Setup Tutorial
22
This tutorial guides you through setting up the **CogStack Observability Stack** for production use.
33

4-
If you're new, we recommend completing the [Quickstart Tutorial](../quickstart.md) first to get a simplified setup running.
4+
If you're new, we recommend completing the [Quickstart Tutorial](../get-started/quickstart.md) first to get a simplified setup running.
55

66
By the end of the tutorial, you will have a complete stack offering all the observability features, customized to your usage.
77

0 commit comments

Comments
 (0)