docs: fix typos (#2222)
This commit is contained in:
Avishek Sen
GitHub
parent
3f1229555e
commit
f773e026d5
10 changed files with 18 additions and 18 deletions
|
|
@ -166,7 +166,7 @@ If you have any questions, suggestions, or general issues, please start a discus
|
|||
|
||||
For bug reports, please open an issue on the [Issues](https://github.com/gethomepage/homepage/issues) page.
|
||||
|
||||
## Contributing & Contributers
|
||||
## Contributing & Contributors
|
||||
|
||||
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ description: Service Widget Configuration
|
|||
|
||||
Unless otherwise noted, URLs should not end with a `/` or other API path. Each widget will handle the path on its own.
|
||||
|
||||
Each service can have one widget attached to it (often matching the service type, but thats not forced).
|
||||
Each service can have one widget attached to it (often matching the service type, but that's not forced).
|
||||
|
||||
In addition to the href of the service, you can also specify the target location in which to open that link. See [Link Target](settings.md#link-target) for more details.
|
||||
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ background:
|
|||
|
||||
### Card Background Blur
|
||||
|
||||
You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the backround blur, saturate and brightness filters.
|
||||
You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the background blur, saturate and brightness filters.
|
||||
|
||||
```yaml
|
||||
cardBlur: sm # sm, "", md, etc... see https://tailwindcss.com/docs/backdrop-blur
|
||||
|
|
@ -329,7 +329,7 @@ You can then pass `provider` instead of `apiKey` in your widget configuration.
|
|||
|
||||
## Quick Launch
|
||||
|
||||
You can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesnt have focus).
|
||||
You can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesn't have focus).
|
||||
|
||||
<img width="1000" alt="quicklaunch" src="https://user-images.githubusercontent.com/4887959/216880811-90ff72cb-2990-4475-889b-7c3a31e6beef.png">
|
||||
|
||||
|
|
@ -422,4 +422,4 @@ or per service widget (`services.yaml`) with:
|
|||
hideErrors: true
|
||||
```
|
||||
|
||||
If either value is set to true, the errror message will be hidden.
|
||||
If either value is set to true, the error message will be hidden.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: OpenWeatherMap
|
|||
description: OpenWeatherMap Information Widget Configuration
|
||||
---
|
||||
|
||||
The free tier "One Call API" is all thats required, you will need to [subscribe](https://home.openweathermap.org/subscriptions/unauth_subscribe/onecall_30/base) and grab your API key.
|
||||
The free tier "One Call API" is all that's required, you will need to [subscribe](https://home.openweathermap.org/subscriptions/unauth_subscribe/onecall_30/base) and grab your API key.
|
||||
|
||||
```yaml
|
||||
- openweathermap:
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ The disk path is the path reported by `df` (Mounted On), or the mount point of t
|
|||
|
||||
The cpu and memory resource information are the container's usage while [glances](glances.md) displays statistics for the host machine on which it is installed.
|
||||
|
||||
_Note: unfortunately, the package used for getting CPU temp ([systeminformation](https://systeminformation.io)) is not compatibile with some setups and will not report any value(s) for CPU temp._
|
||||
_Note: unfortunately, the package used for getting CPU temp ([systeminformation](https://systeminformation.io)) is not compatible with some setups and will not report any value(s) for CPU temp._
|
||||
|
||||
**Any disk you wish to access must be mounted to your container as a volume.**
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ description: Weather API Information Widget Configuration
|
|||
|
||||
**Note: this widget is considered 'deprecated' since there is no longer a free Weather API tier for new members. See the openmeteo or openweathermap widgets for alternatives.**
|
||||
|
||||
The free tier is all thats required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.
|
||||
The free tier is all that's required, you will need to [register](https://www.weatherapi.com/signup.aspx) and grab your API key.
|
||||
|
||||
```yaml
|
||||
- weatherapi:
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ This widget has 2 functions:
|
|||
1. Pipelines: checks if the relevant pipeline is running or not, and if not, reports the last status.\
|
||||
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 atleast 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.\
|
||||
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)
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ For the following JSON object from the API:
|
|||
}
|
||||
```
|
||||
|
||||
Define the `mappings` section as an aray, for example:
|
||||
Define the `mappings` section as an array, for example:
|
||||
|
||||
```yaml
|
||||
mappings:
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ widget:
|
|||
metric: cpu
|
||||
```
|
||||
|
||||
_Please note, this widget does not need an `href`, `icon` or `description` on its parent service. To achive the same effect as the examples above, see as an example:_
|
||||
_Please note, this widget does not need an `href`, `icon` or `description` on its parent service. To achieve the same effect as the examples above, see as an example:_
|
||||
|
||||
```yaml
|
||||
- CPU Usage:
|
||||
|
|
@ -45,15 +45,15 @@ The metric field in the configuration determines the type of system monitoring d
|
|||
|
||||
`process`: Top 5 processes based on CPU usage. Gives an overview of which processes are consuming the most resources.
|
||||
|
||||
`network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specificed in glances.
|
||||
`network:<interface_name>`: Network data usage for the specified interface. Replace `<interface_name>` with the name of your network interface, e.g., `network:enp0s25`, as specified in glances.
|
||||
|
||||
`sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specificed in glances.
|
||||
`sensor:<sensor_id>`: Temperature of the specified sensor, typically used to monitor CPU temperature. Replace `<sensor_id>` with the name of your sensor, e.g., `sensor:Package id 0` as specified in glances.
|
||||
|
||||
`disk:<disk_id>`: Disk I/O data for the specified disk. Replace `<disk_id>` with the id of your disk, e.g., `disk:sdb`, as specificed in glances.
|
||||
`disk:<disk_id>`: Disk I/O data for the specified disk. Replace `<disk_id>` with the id of your disk, e.g., `disk:sdb`, as specified in glances.
|
||||
|
||||
`gpu:<gpu_id>`: GPU usage for the specified GPU. Replace `<gpu_id>` with the id of your GPU, e.g., `gpu:0`, as specificed in glances.
|
||||
`gpu:<gpu_id>`: GPU usage for the specified GPU. Replace `<gpu_id>` with the id of your GPU, e.g., `gpu:0`, as specified in glances.
|
||||
|
||||
`fs:<mnt_point>`: Disk usage for the specified mount point. Replace `<mnt_point>` with the path of your disk, e.g., `/mnt/storage`, as specificed in glances.
|
||||
`fs:<mnt_point>`: Disk usage for the specified mount point. Replace `<mnt_point>` with the path of your disk, e.g., `/mnt/storage`, as specified in glances.
|
||||
|
||||
## Views
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ All widgets offer an alternative to the full or "graph" view, which is the compa
|
|||
|
||||
<img width="970" alt="Screenshot 2023-09-06 at 1 51 48 PM" src="https://github-production-user-asset-6210df.s3.amazonaws.com/82196/265985295-cc6b9adc-4218-4274-96ca-36c3e64de5d0.png">
|
||||
|
||||
To switch to the alternative "graphless" view, simply passs `chart: false` as an option to the widget, like so:
|
||||
To switch to the alternative "graphless" view, simply pass `chart: false` as an option to the widget, like so:
|
||||
|
||||
```yaml
|
||||
- Network Usage:
|
||||
|
|
|
|||
|
|
@ -14,4 +14,4 @@ widget:
|
|||
key: yourpiholeapikey # optional
|
||||
```
|
||||
|
||||
_Added in v0.1.0, udpated in v0.6.18_
|
||||
_Added in v0.1.0, updated in v0.6.18_
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue