Skip to content

Commit c8bdecb

Browse files
committed
docs: Fix ordering in Table of Contents
1 parent 394602b commit c8bdecb

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
5050
- [Conditions](#conditions)
5151
- [Placeholders](#placeholders)
5252
- [Functions](#functions)
53+
- [Announcements](#announcements)
5354
- [Storage](#storage)
5455
- [Client configuration](#client-configuration)
5556
- [Tunneling](#tunneling)
@@ -95,7 +96,6 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
9596
- [Configuring Zulip alerts](#configuring-zulip-alerts)
9697
- [Configuring custom alerts](#configuring-custom-alerts)
9798
- [Setting a default alert](#setting-a-default-alert)
98-
- [Announcements](#announcements)
9999
- [Maintenance](#maintenance)
100100
- [Security](#security)
101101
- [Basic Authentication](#basic-authentication)
@@ -1300,7 +1300,7 @@ endpoints:
13001300
```
13011301

13021302

1303-
#### Configuring ilert alerts
1303+
#### Configuring Ilert alerts
13041304
| Parameter | Description | Default |
13051305
|:-----------------------------------|:-------------------------------------------------------------------------------------------|:--------|
13061306
| `alerting.ilert` | Configuration for alerts of type `ilert` | `{}` |
@@ -1852,6 +1852,40 @@ endpoints:
18521852
```
18531853

18541854

1855+
#### Configuring SendGrid alerts
1856+
1857+
> ⚠️ **WARNING**: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on [#1223](https://github.com/TwiN/gatus/discussions/1223) with whether the provider works as intended. Thank you for your cooperation.
1858+
1859+
| Parameter | Description | Default |
1860+
|:--------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
1861+
| `alerting.sendgrid` | Configuration for alerts of type `sendgrid` | `{}` |
1862+
| `alerting.sendgrid.api-key` | SendGrid API key | Required `""` |
1863+
| `alerting.sendgrid.from` | Email address to send from | Required `""` |
1864+
| `alerting.sendgrid.to` | Email address(es) to send alerts to (comma-separated for multiple recipients) | Required `""` |
1865+
| `alerting.sendgrid.default-alert` | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A |
1866+
| `alerting.sendgrid.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
1867+
| `alerting.sendgrid.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
1868+
| `alerting.sendgrid.overrides[].*` | See `alerting.sendgrid.*` parameters | `{}` |
1869+
1870+
```yaml
1871+
alerting:
1872+
sendgrid:
1873+
api-key: "SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
1874+
1875+
1876+
1877+
endpoints:
1878+
- name: website
1879+
url: "https://twin.sh/health"
1880+
interval: 5m
1881+
conditions:
1882+
- "[STATUS] == 200"
1883+
alerts:
1884+
- type: sendgrid
1885+
send-on-resolved: true
1886+
```
1887+
1888+
18551889
#### Configuring Signal alerts
18561890

18571891
> ⚠️ **WARNING**: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on [#1223](https://github.com/TwiN/gatus/discussions/1223) with whether the provider works as intended. Thank you for your cooperation.
@@ -1918,40 +1952,6 @@ endpoints:
19181952
```
19191953

19201954

1921-
#### Configuring SendGrid alerts
1922-
1923-
> ⚠️ **WARNING**: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on [#1223](https://github.com/TwiN/gatus/discussions/1223) with whether the provider works as intended. Thank you for your cooperation.
1924-
1925-
| Parameter | Description | Default |
1926-
|:--------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
1927-
| `alerting.sendgrid` | Configuration for alerts of type `sendgrid` | `{}` |
1928-
| `alerting.sendgrid.api-key` | SendGrid API key | Required `""` |
1929-
| `alerting.sendgrid.from` | Email address to send from | Required `""` |
1930-
| `alerting.sendgrid.to` | Email address(es) to send alerts to (comma-separated for multiple recipients) | Required `""` |
1931-
| `alerting.sendgrid.default-alert` | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A |
1932-
| `alerting.sendgrid.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
1933-
| `alerting.sendgrid.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
1934-
| `alerting.sendgrid.overrides[].*` | See `alerting.sendgrid.*` parameters | `{}` |
1935-
1936-
```yaml
1937-
alerting:
1938-
sendgrid:
1939-
api-key: "SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
1940-
1941-
1942-
1943-
endpoints:
1944-
- name: website
1945-
url: "https://twin.sh/health"
1946-
interval: 5m
1947-
conditions:
1948-
- "[STATUS] == 200"
1949-
alerts:
1950-
- type: sendgrid
1951-
send-on-resolved: true
1952-
```
1953-
1954-
19551955
#### Configuring Slack alerts
19561956
| Parameter | Description | Default |
19571957
|:-----------------------------------|:-------------------------------------------------------------------------------------------|:------------------------------------|

0 commit comments

Comments
 (0)