feat(docs): migrate documentation site into monorepo (#5912)
This commit is contained in:
1 parent
3e464a76f2
commit
9e421c67bd
605 files changed
+26764
-219
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 8.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: 'UPS'
|
||||
description: 'Monitor the status of your UPS devices through a NUT server.'
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
|
||||
import { upsWidget } from '.';
|
||||
import { peaNutIntegration } from '@site/docs/integrations/peanut';
|
||||
|
||||
<WidgetHeader
|
||||
widget={upsWidget}
|
||||
categories={['UPS']}
|
||||
/>
|
||||
|
||||
This widget displays the status of the UPS devices reported by a Network UPS Tools (NUT) server. Each device shows its
|
||||
status (online, on battery, charging or low battery), battery charge and estimated runtime, output load, and input and
|
||||
output voltage.
|
||||
|
||||
### Layouts
|
||||
|
||||
import screenshotFull from './img/screenshot.png';
|
||||
import screenshotCompact from './img/screenshot-compact.png';
|
||||
import screenshotMini from './img/screenshot-mini.png';
|
||||
|
||||
The widget adapts to the size of the tile, so it stays readable from a full dashboard panel down to a single cell. Multiple UPS devices scroll within the widget at any height.
|
||||
|
||||
| Layout | Size | Preview |
|
||||
| --- | --- | --- |
|
||||
| Full | 3+ columns wide | <img src={screenshotFull} alt="UPS widget full layout" width={239} /> |
|
||||
| Compact | ~2 columns | <img src={screenshotCompact} alt="UPS widget compact layout" width={171} /> |
|
||||
| Mini | 1 column | <img src={screenshotMini} alt="UPS widget mini layout" width={90} /> |
|
||||
|
||||
### Supported Integrations
|
||||
|
||||
<WidgetIntegrations items={[{
|
||||
integration: peaNutIntegration,
|
||||
}]} />
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
<WidgetConfig configuration={upsWidget.configuration} />
|
||||
@@ -0,0 +1,31 @@
|
||||
import { WidgetDefinition } from "@site/src/types";
|
||||
import { IconBatteryCharging } from "@tabler/icons-react";
|
||||
|
||||
export const upsWidget: WidgetDefinition = {
|
||||
icon: IconBatteryCharging,
|
||||
name: "UPS",
|
||||
description: "Monitor the status of your UPS devices through a NUT server.",
|
||||
path: "../../widgets/ups",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Show battery",
|
||||
description: "Displays the battery charge ring and estimated runtime for each UPS device.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show load",
|
||||
description: "Displays the current output load percentage for each UPS device.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show voltage",
|
||||
description: "Displays the input and output voltage for each UPS device.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
Reference in new issue
Block a user