Karl/homepage
1
0
Fork 0
mirror of https://github.com/karl0ss/homepage.git synced 2025-05-01 13:09:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: fix allowed fields uniformity (#3224)

Browse Source
This commit is contained in:
XavierDupuis 2024-04-02 18:42:34 -04:00 committed by GitHub
parent 4e69ea6088
commit 60db01cc57
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/widgets/services/azuredevops.md
View File

@ -7,10 +7,10 @@ Learn more about [Azure DevOps](https://azure.microsoft.com/en-us/products/devop
This widget has 2 functions:
1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.\
1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.<br>
Allowed fields: `["result", "status"]`.
2. Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed.\
2. Pull Requests: returns the amount of open PRs, the amount of the PRs you have open, and how many PRs that you open are marked as 'Approved' by at least 1 person and not yet completed.<br>
Allowed fields: `["totalPrs", "myPrs", "approved"]`.
You will need to generate a personal access token for an existing user, see the [azure documentation](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows#create-a-pat)

2
docs/widgets/services/crowdsec.md
View File

@ -8,7 +8,7 @@ Learn more about [Crowdsec](https://crowdsec.net).
See the [crowdsec docs](https://docs.crowdsec.net/docs/local_api/intro/#machines) for information about registering a machine,
in most instances you can use the default credentials (`/etc/crowdsec/local_api_credentials.yaml`).
Allowed fields: ["alerts", "bans"]
Allowed fields: `["alerts", "bans"]`.
```yaml
widget:

2
docs/widgets/services/gitea.md
View File

@ -7,7 +7,7 @@ Learn more about [Gitea](https://gitea.com).
API token requires `notifications`, `repository` and `issue` permissions. See the [gitea documentation](https://docs.gitea.com/development/api-usage#generating-and-listing-api-tokens) for details on generating tokens.
Allowed fields: ["notifications", "issues", "pulls"]
Allowed fields: `["notifications", "issues", "pulls"]`.
```yaml
widget:

2
docs/widgets/services/peanut.md
View File

@ -9,7 +9,7 @@ This widget adds support for [Network UPS Tools](https://networkupstools.org/) v
The default ups name is `ups`. To configure more than one ups, you must create multiple peanut services.
Allowed fields: `["battery_charge", "ups_load", "ups_status"]`
Allowed fields: `["battery_charge", "ups_load", "ups_status"]`.
!!! note

2
docs/widgets/services/prometheus.md
View File

@ -5,7 +5,7 @@ description: Prometheus Widget Configuration
Learn more about [Prometheus](https://github.com/prometheus/prometheus).
Allowed fields: `["targets_up", "targets_down", "targets_total"]`
Allowed fields: `["targets_up", "targets_down", "targets_total"]`.
```yaml
widget:

2
docs/widgets/services/pterodactyl.md
View File

@ -5,7 +5,7 @@ description: Pterodactyl Widget Configuration
Learn more about [Pterodactyl](https://github.com/pterodactyl).
Allowed fields: `["nodes", "servers"]`
Allowed fields: `["nodes", "servers"]`.
```yaml
widget: