Skip to content

Commit

Permalink
Merge pull request #3361 from davemehr/develop
Browse files Browse the repository at this point in the history
Update installation documentation
  • Loading branch information
wobba authored Nov 29, 2023
2 parents 5fd8955 + 302d15c commit 834d6ae
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
Binary file added docs/assets/installation-enable-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 8 additions & 7 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Installation

1. Download the latest SharePoint Framework packages **pnp-modern-search-parts.sppkg** from the [GitHub repository](https://github.com/microsoft-search/pnp-modern-search/releases).
2. Add **pnp-modern-search-parts.sppkg** to the global tenant app catalog or a site collection app catalog. If you don't have an app catalog, follow this [procedure](https://docs.microsoft.com/en-us/sharepoint/use-app-catalog) to create one.
1. Download the latest SharePoint Framework packages **pnp-modern-search-parts-v4.sppkg** from the [GitHub repository](https://github.com/microsoft-search/pnp-modern-search/releases).
2. Add **pnp-modern-search-parts-v4.sppkg** to the global tenant app catalog or a site collection app catalog. If you don't have an app catalog, follow this [procedure](https://docs.microsoft.com/en-us/sharepoint/use-app-catalog) to create one.

!["App Catalog "](./assets/app_catalog.png){: .center}
!["App Catalog "](./assets/installation-enable-app.png){: .center}

> * The packages are deployed in the general Office 365 CDN meaning **we don't host any code**.
> * For the **pnp-modern-search-parts.sppkg** package, you can choose to make the solution available in [all sites](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-scoped-deployment) or force to install an app to the site every time.
> * For the **pnp-modern-search-parts-v4.sppkg** package, you can choose to make the solution available in [all sites](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-scoped-deployment) or force to install an app to the site every time.
> * The solution asks the following API permissions by default to enhance the experience. These permissions are **not mandatory**. If you don't accept them, you will simply have less available features.
> * You can approve scopes from the API Access screen in the SharePoint Admin Center: https://<tenant>-admin.sharepoint.com/_layouts/15/online/AdminHome.aspx#/webApiPermissionManagement If you'd like more details on this step, please see the [Approving Scopes](#approving-scopes) section below.
| Requested API permission | Used for |
| -------------- | --------- |
| _Presence.Read.All_ | Read presence information of all users in your organization.
| _User.Read_ | The Microsoft Graph Toolkit [persona card](https://docs.microsoft.com/en-us/graph/toolkit/components/person-card#microsoft-graph-permissions) in the people layout. |
| _People.Read_ | Same as above.
| _Contacts.Read_ | Same as above.
Expand All @@ -27,9 +28,9 @@
| _Bookmark.Read.All_ | Allow search for Bookmarks in Microsoft Search in your organization.
| _Acronym.Read.All_ | Allow search for Acronyms in Microsoft Search in your organization.
| _Chat.Read_ | Allow search for Teams messages.
| _ChannelMessage.Read.All_ | Same as above.
| _ChannelMessage.Read.All_ | Read user channel messages.

3. Add the Web Parts to a SharePoint and start building!
4. Add the Web Parts to a SharePoint and start building!

!["Available Web Parts"](./assets/webparts.png){: .center}

Expand All @@ -49,7 +50,7 @@ After you approve each request your view will be as shown in the screenshot belo
## Note about Guest users

By default guest users do not have access to the App Catalog. So if you are not using the CDN option, any SPFx web part from the App Catalog will show an error message for guest users:
![No Access Error](../assets/NoAccessError.png)
![No Access Error](./assets/NoAccessError.png){: .center}

There are basicly two options to solve this issue,
give guest users access to the App Catalog (read) or use the CDN option.
Expand Down

0 comments on commit 834d6ae

Please sign in to comment.