Skip to content

Commit 90dcb5f

Browse files
appieschotVesaJuvonen
authored andcommitted
Added O365CLI docs for Hub sites (SharePoint#4285)
* [docs] Added O365 CLI Hub site commands * [fix] removed wrong file * Update hub-site-o365cli.md Adding notes around SLA and supportability for the CLI. We need to explicitly call these out for all open-source projects mentioned in the docs.
1 parent 94810b1 commit 90dcb5f

File tree

3 files changed

+57
-7
lines changed

3 files changed

+57
-7
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Office 365 CLI commands for SharePoint hub sites
3+
description: Use Office 365 CLI to create and manage SharePoint hub sites.
4+
ms.date: 6/18/2019
5+
localization_priority: Priority
6+
---
7+
8+
# Office 365 CLI commands for SharePoint hub sites
9+
10+
Use the Office 365 CLI commands to create and manage SharePoint hub sites.
11+
12+
> [!NOTE]
13+
> Office 365 CLI is an open-source tool with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
15+
## Get started
16+
17+
To run the Office 365 CLI commands, you'll need to do the following:
18+
19+
1. Download and install [NodeJS LTS version](https://nodejs.org/en/)
20+
21+
2. Follow the instructions at [Installing the CLI](https://pnp.github.io/office365-cli/user-guide/installing-cli/) to install the Office 365 CLI on your machine
22+
23+
3. Follow the instructions at [Logging in to Office 365](https://pnp.github.io/office365-cli/user-guide/connecting-office-365/) to connect to your SharePoint tenant.
24+
25+
To verify your setup and connection, try using the [hubsite list](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-list/) command to list the current hub sites. If the cmdlet runs and returns with no errors, you're ready to proceed.
26+
27+
## Hub site commands
28+
29+
The following commands are available for managing hub sites:
30+
31+
|Command|Description|
32+
|------|-----------|
33+
|[hubsite connect](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-connect)| Connects the specified site collection to the given hub site |
34+
|[hubsite data get](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-data-get)| Get hub site data for the specified site |
35+
|[hubsite disconnect](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-disconnect)| Disconnects the specifies site collection from its hub site |
36+
|[hubsite get](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-get)| Gets information about the specified hub site |
37+
|[hubsite list](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-list)| Lists hub sites in the current tenant |
38+
|[hubsite register](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-register)| Registers the specified site collection as a hub site |
39+
|[hubsite rights grant](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-rights-grant)| Grants permissions to join the hub site for one or more principals |
40+
|[hubsite rights revoke](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-rights-revoke)| Revokes rights to join sites to the specified hub site for one or more principals |
41+
|[hubsite set](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-set)| Updates properties of the specified hub site |
42+
|[hubsite theme sync](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-theme-sync)| Applies any theme updates from the parent hub site. |
43+
|[hubsite unregister](https://pnp.github.io/office365-cli/cmd/spo/hubsite/hubsite-unregister)| Unregisters the specifies site collection as a hub site |
44+
45+
## See also
46+
47+
- [SharePoint hub sites overview](hub-site-overview.md)
48+
- [PowerShell cmdlets for SharePoint hub sites](hub-site-powershell.md)

docs/features/hub-site/hub-site-overview.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: SharePoint hub sites overview
3-
description: SharePoint hub sites connect and organize sites based on organizational attributes such as project, department, division, or region.
3+
description: SharePoint hub sites connect and organize sites based on organizational attributes such as project, department, division, or region.
44
ms.date: 4/20/2018
55
localization_priority: Priority
66
---
@@ -15,18 +15,19 @@ For more information about creating hub sites, see [Create SharePoint hub sites
1515

1616
## Additional details
1717

18-
- We recommend that you select a communication site or a team site that uses the modern template. If you use a classic team site, the hub site navigation will only appear on modern pages, including document libraries, lists, and site contents. Hub site settings will only appear on modern pages.
18+
- We recommend that you select a communication site or a team site that uses the modern template. If you use a classic team site, the hub site navigation will only appear on modern pages, including document libraries, lists, and site contents. Hub site settings will only appear on modern pages.
1919

20-
- You can create up to 100 hub sites for an organization.
20+
- You can create up to 100 hub sites for an organization.
2121

22-
- If you set up [SharePoint Multi-Geo](../../solution-guidance/multigeo-introduction.md) for your organization, any geo ___location where the SharePoint workload is available can be associated with a hub site.
22+
- If you set up [SharePoint Multi-Geo](../../solution-guidance/multigeo-introduction.md) for your organization, any geo ___location where the SharePoint workload is available can be associated with a hub site.
2323

24-
- When users associate their sites with a hub site, it doesn't impact the permissions of either the hub site or the associated sites. It's important to ensure that all users you allow to associate sites to the hub site have permission to the hub site.
24+
- When users associate their sites with a hub site, it doesn't impact the permissions of either the hub site or the associated sites. It's important to ensure that all users you allow to associate sites to the hub site have permission to the hub site.
2525

26-
- The hub site navigation that is shown on all associated sites is based on the top navigation bar of the hub site. To make programmatic changes to the hub site navigation, you can use the REST API, CSOM API, or PnP PowerShell.
26+
- The hub site navigation that is shown on all associated sites is based on the top navigation bar of the hub site. To make programmatic changes to the hub site navigation, you can use the REST API, CSOM API, or PnP PowerShell.
2727

2828

2929
## See also
3030

3131
- [PowerShell cmdlets for SharePoint hub sites](hub-site-powershell.md)
32+
- [Office 365 CLI commands for SharePoint hub sites](hub-site-o365cli.md)
3233
- [Get to know the SharePoint REST service](../../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)

docs/features/hub-site/hub-site-powershell.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Use PowerShell cmdlets to create and manage SharePoint hub sites.
1313

1414
To run the PowerShell cmdlets:
1515

16-
1. Download and install the [SharePoint Online Management Shell](https://www.microsoft.com/en-us/download/details.aspx?id=35588). If you already have a previous version of the shell installed, uninstall it first, and then install the latest version.
16+
1. Download and install the [SharePoint Online Management Shell](https://www.microsoft.com/en-us/download/details.aspx?id=35588). If you already have a previous version of the shell installed, uninstall it first, and then install the latest version.
1717

1818
2. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/en-us/library/fp161372.aspx) to connect to your SharePoint tenant.
1919

@@ -37,3 +37,4 @@ The following PowerShell cmdlets are available for managing hub sites:
3737
## See also
3838

3939
- [SharePoint hub sites overview](hub-site-overview.md)
40+
- [Office 365 CLI commands for SharePoint hub sites](hub-site-o365cli.md)

0 commit comments

Comments
 (0)