Skip to content

Commit

Permalink
Update help. (#1275)
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdriscoll authored Oct 21, 2019
1 parent abdb5be commit b639151
Show file tree
Hide file tree
Showing 60 changed files with 1,137 additions and 593 deletions.
47 changes: 47 additions & 0 deletions src/UniversalDashboard/Help/Clear-UDCache.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
external help file: UniversalDashboard.Community-help.xml
Module Name: UniversalDashboard.Community
online version:
schema: 2.0.0
---

# Clear-UDCache

## SYNOPSIS
Clears the Universal Dashboard cache scope.

## SYNTAX

```
Clear-UDCache [<CommonParameters>]
```

## DESCRIPTION
Clears the Universal Dashboard cache scope. Existing $Cache variables will no longer be present.

## EXAMPLES

### Example 1
```
PS C:\> Clear-UDCache
```

Clears the UD cache.

## PARAMETERS

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

43 changes: 22 additions & 21 deletions src/UniversalDashboard/Help/New-UDButton.md

Large diffs are not rendered by default.

39 changes: 28 additions & 11 deletions src/UniversalDashboard/Help/New-UDCard.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/UniversalDashboard/Help/New-UDChart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Creates a new chart.

```
New-UDChart [-Labels <String[]>] [-Type <ChartType>] [-Title <String>] [-Options <Hashtable>] [-Width <String>]
[-Height <String>] [-BackgroundColor <DashboardColor>] [-FontColor <DashboardColor>] [-Links <Link[]>]
[-Height <String>] [-BackgroundColor <DashboardColor>] [-FontColor <DashboardColor>] [-Links <Hashtable[]>]
[-FilterFields <ScriptBlock>] [-OnClick <Object>] [-Endpoint <ScriptBlock>] [-ArgumentList <Object[]>]
[-AutoRefresh] [-RefreshInterval <Int32>] [-Id <String>] [<CommonParameters>]
```
Expand Down Expand Up @@ -205,7 +205,7 @@ Accept wildcard characters: False
Links to display on the bottom of the chart. Use New-UDLink to generate a link.
```yaml
Type: Link[]
Type: Hashtable[]
Parameter Sets: (All)
Aliases:

Expand Down
1 change: 1 addition & 0 deletions src/UniversalDashboard/Help/New-UDCheckbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ New-UDCheckbox -Label "Checkbox" -OnChange {
Show-UDToast -Message $EventData
}
```

Displays a toast message when clicked.

## PARAMETERS
Expand Down
6 changes: 3 additions & 3 deletions src/UniversalDashboard/Help/New-UDCollapsibleItem.md

Large diffs are not rendered by default.

25 changes: 20 additions & 5 deletions src/UniversalDashboard/Help/New-UDCounter.md

Large diffs are not rendered by default.

26 changes: 5 additions & 21 deletions src/UniversalDashboard/Help/New-UDDashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Creates a new dashboard. The result of this cmdlet should be passed to Start-UDD
```
New-UDDashboard [-Title <String>] -Content <ScriptBlock> [-NavBarColor <DashboardColor>]
[-NavBarFontColor <DashboardColor>] [-BackgroundColor <DashboardColor>] [-FontColor <DashboardColor>]
[-FontIconStyle <String>] [-NavbarLinks <Link[]>] [-Scripts <String[]>] [-Stylesheets <String[]>]
[-CyclePages] [-CyclePagesInterval <Int32>] [-Footer <Footer>] [-NavBarLogo <Element>]
[-NavbarLinks <Hashtable[]>] [-Scripts <String[]>] [-Stylesheets <String[]>] [-CyclePages]
[-CyclePagesInterval <Int32>] [-Footer <Footer>] [-NavBarLogo <Element>]
[-EndpointInitialization <InitialSessionState>] [-Theme <Theme>] [-GeoLocation] [-IdleTimeout <TimeSpan>]
[-Navigation <SideNav>] [<CommonParameters>]
```
Expand All @@ -26,8 +26,8 @@ New-UDDashboard [-Title <String>] -Content <ScriptBlock> [-NavBarColor <Dashboar
```
New-UDDashboard [-Title <String>] -Pages <Page[]> [-NavBarColor <DashboardColor>]
[-NavBarFontColor <DashboardColor>] [-BackgroundColor <DashboardColor>] [-FontColor <DashboardColor>]
[-FontIconStyle <String>] [-NavbarLinks <Link[]>] [-Scripts <String[]>] [-Stylesheets <String[]>]
[-CyclePages] [-CyclePagesInterval <Int32>] [-Footer <Footer>] [-NavBarLogo <Element>]
[-NavbarLinks <Hashtable[]>] [-Scripts <String[]>] [-Stylesheets <String[]>] [-CyclePages]
[-CyclePagesInterval <Int32>] [-Footer <Footer>] [-NavBarLogo <Element>]
[-EndpointInitialization <InitialSessionState>] [-Theme <Theme>] [-GeoLocation] [-IdleTimeout <TimeSpan>]
[-Navigation <SideNav>] [<CommonParameters>]
```
Expand Down Expand Up @@ -159,22 +159,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -FontIconStyle
Choose the style of the icons, filled or line.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: FontAwesome, LineAwesome

Required: False
Position: Named
Default value: FontAwesome
Accept pipeline input: False
Accept wildcard characters: False
```
### -Footer
Configuration options for the footer. Use New-UDFooter to create the object for these options.
Expand Down Expand Up @@ -271,7 +255,7 @@ Accept wildcard characters: False
Links to present on the dashboard. Use New-UDLink to create links.
```yaml
Type: Link[]
Type: Hashtable[]
Parameter Sets: (All)
Aliases:

Expand Down
17 changes: 16 additions & 1 deletion src/UniversalDashboard/Help/New-UDEndpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ New-UDEndpoint -Endpoint <ScriptBlock> [-ArgumentList <Object[]>] [-Id <String>]
### Rest
```
New-UDEndpoint -Endpoint <ScriptBlock> [-ArgumentList <Object[]>] [-Id <String>] -Url <String>
[-EvaluateUrlAsRegex] [-Method <String>] [<CommonParameters>]
[-EvaluateUrlAsRegex] [-Method <String>] [-AcceptFileUpload] [<CommonParameters>]
```

### Scheduled
Expand Down Expand Up @@ -69,6 +69,21 @@ Creates a REST API endpoint that accepts a HTTP POST with a name parameter in th

## PARAMETERS

### -AcceptFileUpload
Enabled uploading files to this REST API endpoint.

```yaml
Type: SwitchParameter
Parameter Sets: Rest
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ArgumentList
Arguments to pass to the endpoint. They will be available via the $ArgumentList variable.
Expand Down
47 changes: 23 additions & 24 deletions src/UniversalDashboard/Help/New-UDEndpointSchedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,27 @@ Creates a schedule for an endpoint.

### EverySecond
```
New-UDEndpointSchedule -Every <Int32> [-Second] [-Repeat] [-Consecutive] [<CommonParameters>]
New-UDEndpointSchedule -Every <Int32> [-Repeat <Int32>] [-Consecutive] [-Second] [<CommonParameters>]
```

### EveryMinute
```
New-UDEndpointSchedule -Every <Int32> [-Minute] [-Repeat] [-Consecutive] [<CommonParameters>]
New-UDEndpointSchedule -Every <Int32> [-Repeat <Int32>] [-Consecutive] [-Minute] [<CommonParameters>]
```

### EveryHour
```
New-UDEndpointSchedule -Every <Int32> [-Hour] [-Repeat] [-Consecutive] [<CommonParameters>]
New-UDEndpointSchedule -Every <Int32> [-Repeat <Int32>] [-Consecutive] [-Hour] [<CommonParameters>]
```

### EveryDay
```
New-UDEndpointSchedule -Every <Int32> [-Day] [-Repeat] [-Consecutive] [<CommonParameters>]
New-UDEndpointSchedule -Every <Int32> [-Repeat <Int32>] [-Consecutive] [-Day] [<CommonParameters>]
```

### Cron
```
New-UDEndpointSchedule [-Cron <String>] [-Consecutive] [<CommonParameters>]
New-UDEndpointSchedule [-Consecutive] [-Cron <String>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -74,15 +74,14 @@ PS C:\> $Endpoint = New-UDEndpoint -Schedule $Schedule -Endpoint {

Gets the current date every 30 seconds 10 times.


## PARAMETERS

### -Cron
A CRON expression to run the schedule under.
### -Consecutive
Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.

```yaml
Type: String
Parameter Sets: Cron
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Expand All @@ -92,12 +91,12 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Consecutive
Disables concurrently running this schedule. Ie, it does not allow the schedule to run multiple instances.
### -Cron
A CRON expression to run the schedule under.
```yaml
Type: Switch
Parameter Sets: Cron, EveryDay, EveryHour, EveryMinute, EverySecond
Type: String
Parameter Sets: Cron
Aliases:

Required: False
Expand Down Expand Up @@ -167,30 +166,30 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Second
Switches the Every value to seconds.
### -Repeat
If set to 0 this means repeat forever, if not set it will also repeat forever. Otherwise it will run the schedule x amount of times.
```yaml
Type: SwitchParameter
Parameter Sets: EverySecond
Type: Int32
Parameter Sets: EverySecond, EveryMinute, EveryHour, EveryDay
Aliases:

Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Repeat
If set to 0 this means repeat forever, if not set it will also repeat forever. Otherwise it will run the schedule x amount of times.
### -Second
Switches the Every value to seconds.
```yaml
Type: Int32
Parameter Sets: EveryDay, EveryHour, EveryMinute, EverySecond
Type: SwitchParameter
Parameter Sets: EverySecond
Aliases:

Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Expand Down
54 changes: 43 additions & 11 deletions src/UniversalDashboard/Help/New-UDFab.md

Large diffs are not rendered by default.

25 changes: 20 additions & 5 deletions src/UniversalDashboard/Help/New-UDFabButton.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/UniversalDashboard/Help/New-UDFooter.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Configuration options for the footer.
## SYNTAX

```
New-UDFooter [-Links <Link[]>] [-Copyright <String>] [-BackgroundColor <DashboardColor>]
New-UDFooter [-Links <Hashtable[]>] [-Copyright <String>] [-BackgroundColor <DashboardColor>]
[-FontColor <DashboardColor>] [-Endpoint <ScriptBlock>] [-ArgumentList <Object[]>] [-AutoRefresh]
[-RefreshInterval <Int32>] [-Id <String>] [<CommonParameters>]
```
Expand Down Expand Up @@ -142,7 +142,7 @@ Accept wildcard characters: False
Links to display in the footer. Use New-UDLink to generate a link.
```yaml
Type: Link[]
Type: Hashtable[]
Parameter Sets: (All)
Aliases:

Expand Down
Loading

0 comments on commit b639151

Please sign in to comment.