From 551ba61bf2322e5d4a1c9e349568a614fcd4620d Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Mon, 7 Nov 2022 22:27:45 -0500 Subject: [PATCH] Updated readme --- samples/react-directory/README.md | 43 ++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 12 deletions(-) diff --git a/samples/react-directory/README.md b/samples/react-directory/README.md index dc636d578..2c8dd9ab0 100755 --- a/samples/react-directory/README.md +++ b/samples/react-directory/README.md @@ -41,9 +41,10 @@ ## Applies to -* [SharePoint Online](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) -* [Microsoft Teams](https://products.office.com/en-US/microsoft-teams/group-chat-software) -* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) +* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) +* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) + +> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/m365devprogram) ## Web Part Properties @@ -72,7 +73,7 @@ Directory Web Part| Abderahman Moujahid Version|Date|Comments -------|----|-------- 1.0.0|July 29, 2019|Initial release -1.0.1|July 19, 2020|Bugfix and mock-service for workbench (```LivePersonaCard``` not supported in workbench) +1.0.1|July 19, 2020|Bugfix and mock-service for workbench (`LivePersonaCard` not supported in workbench) 2.0.0|Sep 18 2020|React hooks, paging, dynamic search props, result alignment using office ui fabric stack. 3.0.0|Oct 17 2020|Minor fixes and add the additional web part property. 3.0.1|March 4 2021|Bugfix 'Sort People by' @@ -80,20 +81,38 @@ Version|Date|Comments 3.0.3|Oct 4 2022|Fix for LivePersonaCard -## Disclaimer - -**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** - ---- - ## Minimal Path to Awesome -- Clone this repository -- in the command line run: +* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-directory) then unzip it) +* From your command line, change your current directory to the directory containing this sample (`react-directory`, located under `samples`) +* in the command line run: - `npm install` - `gulp build` - `gulp bundle --ship` - `gulp package-solution --ship` - `Add to AppCatalog and deploy` +> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit for further instructions. + +## Help + + +We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues. + +If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment. + +You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-directory%22) to see if anybody else is having the same issues. + +You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-directory) and see what the community is saying. + +If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-directory&template=bug-report.yml&sample=react-directory&authors=@joaojmendes%20@petkir_at%20@sudharsank%20@Abderahman88&title=react-directory%20-%20). + +For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-directory&template=question.yml&sample=react-directory&authors=@joaojmendes%20@petkir_at%20@sudharsank%20@Abderahman88&title=react-directory%20-%20). + +Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-directory&template=suggestion.yml&sample=react-directory&authors=@joaojmendes%20@petkir_at%20@sudharsank%20@Abderahman88&title=react-directory%20-%20). + +## Disclaimer + +**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** +