Skip to content

Cleaned up parameter descriptions #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 10, 2018
Merged

Cleaned up parameter descriptions #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eda24e
cleaned up param descriptions
davidchesnut Mar 19, 2018
885d627
Force new merge check.
kenwith Apr 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file:
applicable: SharePoint Online
title: Add-SPOHubSiteAssociation
Expand Down Expand Up @@ -71,17 +71,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### 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

## OUTPUTS

## NOTES

If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.

If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error.

## RELATED LINKS
13 changes: 1 addition & 12 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This example begins with the online-marketing site. The cmdlet finds the associa

### -Identity

URL of the hub site. If not specified, the cmdlet lists all site hubs in the tenant.
URL of the hub site. If not specified, the cmdlet lists all hub sites in the tenant.

```yaml
Type: SpoSitePipeBind
Expand All @@ -72,14 +72,3 @@ Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### 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

## OUTPUTS

## NOTES

## RELATED LINKS
11 changes: 0 additions & 11 deletions sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,3 @@ Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### 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

## OUTPUTS

## NOTES

## RELATED LINKS
9 changes: 0 additions & 9 deletions sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,10 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### 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

## OUTPUTS

## NOTES

If the site doesn’t exist, this cmdlet returns a “File not found” error.

If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error.

If the site is already associated with another hub site, this cmdlet returns a "This site is currently associated with a HubSite" error. You'll need to run the [Remove-SPOHubSiteAssociation](Remove-SPOHubSiteAssociation.md) cmdlet first before you can make the site a hub site.

## RELATED LINKS
11 changes: 0 additions & 11 deletions sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,3 @@ Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### 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

## OUTPUTS

## NOTES

## RELATED LINKS
15 changes: 2 additions & 13 deletions sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ This example shows how to revoke rights so that Nestor can no longer join sites

## PARAMETERS

### -SiteUrl
### -Identity

URL of the hub site.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Aliases: HubSite
Applicable: SharePoint Online

Required: True
Expand All @@ -71,14 +71,3 @@ Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### 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

## OUTPUTS

## NOTES

## RELATED LINKS
13 changes: 1 addition & 12 deletions sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ URL of the hub site.
```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Aliases: HubSite
Applicable: SharePoint Online

Required: True
Expand Down Expand Up @@ -110,14 +110,3 @@ Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### 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

## OUTPUTS

## NOTES

## RELATED LINKS
41 changes: 32 additions & 9 deletions sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ This example disables the hub feature on the marketing site.

## PARAMETERS

### -Site
### -Identity

URL of the site to disable the hub site feature.

```yaml
Type: SpoSitePipeBind
Type: SpoHubSitePipeBind
Parameter Sets: (All)
Aliases:
Aliases: HubSite
Applicable: SharePoint Online

Required: True
Expand All @@ -55,13 +55,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### 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).
### -WhatIf

## INPUTS
Shows what would happen if the cmdlet runs. The cmdlet is not run.

## OUTPUTS
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Applicable: SharePoint Online

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm

## NOTES
Prompts you for confirmation before running the cmdlet.

## RELATED LINKS
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: SharePoint Online

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```