diff --git a/samples/js-teams-meeting-app/README.md b/samples/js-teams-meeting-app/README.md index 2a95012fc..6d3934ec1 100644 --- a/samples/js-teams-meeting-app/README.md +++ b/samples/js-teams-meeting-app/README.md @@ -1,4 +1,4 @@ -# SPFx WebPart in Teams Meetings App +# SPFx web part in Teams Meetings App Demo SPFx web part project that demonstrates using as a Microsoft Teams meetings app. This is associated with the SPFx docs tutorial: [Tutorial: Build meeting apps for Microsoft Teams with SPFx](https://docs.microsoft.com/sharepoint/dev//spfx/build-for-teams-meeting-app) @@ -38,19 +38,14 @@ Version | Date | Comments ------- | -------------- | --------------- 1.0 | April 27, 2021 | Initial release -## 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 Refer to the above mentioned SPFx tutorial for full repro instructions. - Clone this repository -- ZIP the contents of the **./teams** folder, *but not the folder itself* - - rename the ZIP to **TeamsSPFxApp.zip** +- ZIP the contents of the `./teams` folder, *but not the folder itself* + - rename the ZIP to `TeamsSPFxApp.zip` - From the command line install all dependencies and create the package: ```console @@ -59,10 +54,31 @@ Refer to the above mentioned SPFx tutorial for full repro instructions. gulp package-solution -p ``` -- Upload the **.sppkg** to your SPO tenant's app catalog & deploy it +- Upload the `.sppkg` to your SPO tenant's app catalog & deploy it - select the uploaded package, then select the **Sync to Teams** button in the **Files** tab in the ribbon - In Microsoft Teams, create a new meeting using the **Calendar** app in the leftmost navigation bar - After creating the meeting, edit it, and select the **+** in the tab bar - Select the app you deployed to install the app +## 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%20js-teams-meeting-app%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=js-teams-meeting-app) and see what the community is saying. + +If you encounter any issues while 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%20js-teams-meeting-app&template=bug-report.yml&sample=js-teams-meeting-app&authors=@andrewconnell&title=js-teams-meeting-app%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%20js-teams-meeting-app&template=question.yml&sample=js-teams-meeting-app&authors=@andrewconnell&title=js-teams-meeting-app%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%20js-teams-meeting-app&template=suggestion.yml&sample=js-teams-meeting-app&authors=@andrewconnell&title=js-teams-meeting-app%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.** + diff --git a/samples/react-add-js-css-ref/README.md b/samples/react-add-js-css-ref/README.md index a8a0e5c64..b0f53e1ed 100644 --- a/samples/react-add-js-css-ref/README.md +++ b/samples/react-add-js-css-ref/README.md @@ -19,7 +19,7 @@ This repo is a react based SPFx web part and extension that allows users to add/ WebPart in Action -![Web part in action](assets/webpartinaction.gif?raw=true "Webpart in action") +![Web part in action](assets/webpartinaction.gif?raw=true "web part in action") Challenges/Drawback with ONLY using SPFx extension for adding js and css file references. * JS and CSS file references links needs to be hardcoded in solution diff --git a/samples/react-edit-applicationcustomizer/README.md b/samples/react-edit-applicationcustomizer/README.md index 627a3cbfb..242f9e60d 100644 --- a/samples/react-edit-applicationcustomizer/README.md +++ b/samples/react-edit-applicationcustomizer/README.md @@ -4,7 +4,7 @@ This web part will allow users to view/update application customizers properties across any web where the current user has access to. This web part can be helpful when we require to update the properties for application customizer without using any PowerShell script or cli tool. -![Web part in action](assets/react-all-applicationcustomizers.gif?raw=true "Webpart in action") +![Web part in action](assets/react-all-applicationcustomizers.gif?raw=true "web part in action") ## Idea behind this web part diff --git a/samples/react-find-parker/README.md b/samples/react-find-parker/README.md index 15789aaee..263150aa2 100644 --- a/samples/react-find-parker/README.md +++ b/samples/react-find-parker/README.md @@ -3,7 +3,7 @@ ## Summary Work is not about work 🤨, sometimes a bit of fun is in order 🕹️. -This webpart is a simple find object game. +This web part is a simple find object game. ![parker](./assets/parker.gif) User may set up how many elements will she or he be looking for in the property pane diff --git a/samples/react-graph-groupviewer/README.md b/samples/react-graph-groupviewer/README.md index 66574b78e..301fcc933 100644 --- a/samples/react-graph-groupviewer/README.md +++ b/samples/react-graph-groupviewer/README.md @@ -2,7 +2,7 @@ ## Summary -This webpart will provide the functionality to search for groups in your tenant and allow you to view the details of the selected group as well as view a list of group members and export the list of members to a CSV file. +This web part will provide the functionality to search for groups in your tenant and allow you to view the details of the selected group as well as view a list of group members and export the list of members to a CSV file. ![picture of the web part in action](assets/preview.gif) diff --git a/samples/react-list-items-menu-sp2019/README.md b/samples/react-list-items-menu-sp2019/README.md index da262ed91..4e607540a 100644 --- a/samples/react-list-items-menu-sp2019/README.md +++ b/samples/react-list-items-menu-sp2019/README.md @@ -29,7 +29,7 @@ When the user clicks on the header it dynamically load documents. [SharePoint Framework](https://aka.ms/spfx) -## WebPart Properties +## Web Part Properties Property |Type|Required| comments --------------------|----|--------|---------- diff --git a/samples/react-manage-profile-card-properties/README.md b/samples/react-manage-profile-card-properties/README.md index df717f589..7507df6ec 100644 --- a/samples/react-manage-profile-card-properties/README.md +++ b/samples/react-manage-profile-card-properties/README.md @@ -36,7 +36,7 @@ Only users with Tenant Admin Role are allowed to managed profile card properties * [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) * [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) -## WebPart Properties +## Web Part Properties Property |Type|Required| comments --------------------|----|--------|---------- diff --git a/samples/react-manage-sitedesigns/README.md b/samples/react-manage-sitedesigns/README.md index b4158aea7..662e8e6f0 100644 --- a/samples/react-manage-sitedesigns/README.md +++ b/samples/react-manage-sitedesigns/README.md @@ -100,7 +100,7 @@ Only users with Tenant Admin Role are allowed to managed tenant properties. * [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) * [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) -## WebPart Properties +## Web Part Properties Property |Type|Required| comments --------------------|----|--------|---------- diff --git a/samples/react-modern-organization-chart/README.md b/samples/react-modern-organization-chart/README.md index 1c287ef6b..dbc951d60 100644 --- a/samples/react-modern-organization-chart/README.md +++ b/samples/react-modern-organization-chart/README.md @@ -28,7 +28,7 @@ On Click the profile page of will be open. ![](../react-modern-organization-chart/assets/Screenshot2.png) -## WebPart Properties +## Web Part Properties Property |Type|Required| comments --------------------|----|--------|---------- diff --git a/samples/react-multimedia-gallery/README.md b/samples/react-multimedia-gallery/README.md index 25e9be4c1..6f0779a3f 100644 --- a/samples/react-multimedia-gallery/README.md +++ b/samples/react-multimedia-gallery/README.md @@ -43,7 +43,7 @@ It uses Microsoft Graph API to get thumbnails and image/video url and use PnPjs * [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) -## WebPart Properties +## Web Part Properties | Property | Type | Required | comments | | --------------------- | --------------- | -------- | --------------------------------- | diff --git a/samples/react-mytasks/README.md b/samples/react-mytasks/README.md index 4b91cb35c..3d39c395d 100644 --- a/samples/react-mytasks/README.md +++ b/samples/react-mytasks/README.md @@ -66,7 +66,7 @@ The user can search task by name, can filter by progress status, all data are dy * [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) * [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) -## WebPart Properties +## Web Part Properties Property |Type|Required| comments --------------------|----|--------|---------- diff --git a/samples/react-news/README.md b/samples/react-news/README.md index fbc7dd5f3..088864224 100644 --- a/samples/react-news/README.md +++ b/samples/react-news/README.md @@ -1,13 +1,13 @@ # News -SPFx Webpart to display News from SharePoint site(s) +SPFx web part to display news from SharePoint site(s) ## SharePoint News Posts with SPFx ### Summary Web part pulls all SharePoint News Posts that the logged in user has access to view. - Pagination ( Back/Next ) and Page Display ( n out of n ) - - Select Multiple Sites ( Defaults to site webpart is deployed to ) + - Select Multiple Sites ( Defaults to site web part is deployed to ) - Two styling options, Stack or Single - News Title as link ( Click to go to post ) - News Thumbnail Image diff --git a/samples/react-private-libraries/README.md b/samples/react-private-libraries/README.md index 2c2714ee1..ebcbaeb2c 100644 --- a/samples/react-private-libraries/README.md +++ b/samples/react-private-libraries/README.md @@ -2,7 +2,7 @@ ## Summary -This sample provides a webpart that can be used to manage Document Libraries with Secured Subfolders. The use case this was developed for is a Request for Proposal site. A Document library is created for each RFP and subfolders are created within that Library for each external supplier invited to participate in that RFP. +This sample provides a web part that can be used to manage Document Libraries with Secured Subfolders. The use case this was developed for is a Request for Proposal site. A Document library is created for each RFP and subfolders are created within that Library for each external supplier invited to participate in that RFP. The application manages all the security groups set up for the various libraries and folders so that suppliers only see RFP's they were invited to participate in and only thier folder in those libraries. General documents for the RFP that should be seen by everyone participating in the RFP can be put in the root folder of the library. General terms and conditions that everyone should see can be put at the root folder of the site. @@ -71,16 +71,16 @@ The RFX Folder List The scripts folder contains a site script (rfx.json) that can be used to create these lists. The Powershell Script AddLists.ps1 in the same folder can be run to create a site design that creates these lists. -After creating the lists create a new site page and add the Request Maintenance webpart to it. (Break inheritance on the page and ensure only site members or owners have access to it!) +After creating the lists create a new site page and add the Request Maintenance web part to it. (Break inheritance on the page and ensure only site members or owners have access to it!) -The webpart configuration is below: +The web part configuration is below: ![Configuration](assets/Configuration.PNG "Configuration") The settings are : * RFX List - the title of the RFX list created above. For each new RFX library created this list will contain the library Name, A closing date (just informational for now, but we could set up a workflow to break access on this date), a contract specialist (the person who create the library and owns it), and the ID's of the Libraries Owner, members and Visitors group. When a new library is added a separate Owners member and visitors group is created just for that library. The person creating the library is added to the Libraries Owner group and the Library Owners group becomes the owner of the Library Members and Visitors Groups, as well as any Folder-level groups within the library. -* RFX Folders List - The title of the RFX Folders list created above. Whenever a new folder is added to a library using the webpart a new entry will be created in this list containing the RFX Name (a lookup to the RFX list), The FOlder Name, and the ID of the folder Members and Visitors groups. Whenever a new folder is created Members and visitors groups are created just for that folder. The Library Owners group of the library containing the folder is also of the Folder Members and Visitors groups. +* RFX Folders List - The title of the RFX Folders list created above. Whenever a new folder is added to a library using the web part a new entry will be created in this list containing the RFX Name (a lookup to the RFX list), The FOlder Name, and the ID of the folder Members and Visitors groups. Whenever a new folder is created Members and visitors groups are created just for that folder. The Library Owners group of the library containing the folder is also of the Folder Members and Visitors groups. * Archive Library - The name of a standard document library that can be used to Archive RFX libraries after they are done. If no library name is entered, the Ardchive button will not be shown. When a library is Archived, it is moved to a subfolder in the Archive Library and ALL securiy groups associated with that RFX Library are deleted. @@ -122,7 +122,7 @@ The settings are : * Can be used as an alternative to MS Teams for sharing data with external counterparties. All the data is in one site so its easier to manage. Additionl libraries and content can be created at the site level to be shared with all people who have access to the site. -* Security is easy to manage, just go to the webpart and find the Library or folder you want to gran access to and click on the appropriate group. You can see who has access and add / remove users in one spot. +* Security is easy to manage, just go to the web part and find the Library or folder you want to gran access to and click on the appropriate group. You can see who has access and add / remove users in one spot. * The Recent Actibity command can be used to see what activity has taken place recently within the givern library. diff --git a/samples/react-recaptcha/README.md b/samples/react-recaptcha/README.md index ed1343140..8dc6cf6a1 100644 --- a/samples/react-recaptcha/README.md +++ b/samples/react-recaptcha/README.md @@ -7,7 +7,7 @@ business requirement if you need to implement CAPTCHA in SPFx webpart. * Please refer this [link](https://www.c-sharpcorner.com/article/google-recaptcha-in-sharepoint-framework-webpartspfx/) to know 'How to build this from Scratch' -![Webpart in action](screens/WebpartInAction.gif?raw=true "Webpart in action") +![web part in action](screens/WebpartInAction.gif?raw=true "web part in action") # Compatibility diff --git a/samples/react-sitepages-metadata/README.md b/samples/react-sitepages-metadata/README.md index b96edb178..e20697ec0 100644 --- a/samples/react-sitepages-metadata/README.md +++ b/samples/react-sitepages-metadata/README.md @@ -1,7 +1,7 @@ # react-sitepages-metadata ## Summary -Solution provides an enhancement to SitePages library that enables updating existing items with metadata, and a rollup WebPart to display them. +Solution provides an enhancement to SitePages library that enables updating existing items with metadata, and a rollup web part to display them. ### News rollup WebPart ![News rollup WebPart](./assets/demo-wp.gif) @@ -47,12 +47,12 @@ Solution provides an enhancement to SitePages library that enables updating exis Relies heavily on Office UI Fabric. Contains following elements: -- Metadata-News rollup WebPart - displays published SitePages items (promoted to news), provides filtering and paging capabilities, as well as many configuration options +- Metadata-News rollup web part - displays published SitePages items (promoted to news), provides filtering and paging capabilities, as well as many configuration options - CommandSet extension for SitePages library - a button appears when a single item is selected. Clicking on the item shows a fillable dialog with lookup fields ### Important notes -- Changes in some WebPart properties will not be reflected after hitting "Apply" button - please refresh the page, too -- To see a collection of lookup fields in the WebPart property pane change/edit any of the instantly visible properties, such as Item limit, width or item height. Reason for this is SitePages library will be queried for lookup lists only after the property pane is initially opened +- Changes in some web part properties will not be reflected after hitting "Apply" button - please refresh the page, too +- To see a collection of lookup fields in the web part property pane change/edit any of the instantly visible properties, such as Item limit, width or item height. Reason for this is SitePages library will be queried for lookup lists only after the property pane is initially opened ### Resources - [React Quick Start](https://facebook.github.io/react/docs/tutorial.html) diff --git a/samples/react-sites-selected-admin/README.md b/samples/react-sites-selected-admin/README.md index cd9ff55fc..304a7f121 100644 --- a/samples/react-sites-selected-admin/README.md +++ b/samples/react-sites-selected-admin/README.md @@ -10,15 +10,15 @@ The web part uses the built in MSGraphClient and needs to be approved in API man ## Web part usage -![alt text][Webpart in action] +![alt text][web part in action] -[Webpart in action]: ./assets/sites-manager-demo.gif "Sites Selected Manager in action" +[web part in action]: ./assets/sites-manager-demo.gif "Sites Selected Manager in action" ## Using the web part to grant an app access to a site, start to finish -![alt text][Webpart in action - Visual Studio] +![alt text][web part in action - Visual Studio] -[Webpart in action - Visual Studio]: ./assets/vsDemo.gif "Sites Selected Manager Demo" +[web part in action - Visual Studio]: ./assets/vsDemo.gif "Sites Selected Manager Demo" ## Compatibility diff --git a/samples/react-teams-tabs-pnpjs/README.md b/samples/react-teams-tabs-pnpjs/README.md index d14e5ae84..49bed8005 100644 --- a/samples/react-teams-tabs-pnpjs/README.md +++ b/samples/react-teams-tabs-pnpjs/README.md @@ -2,7 +2,7 @@ ## Summary -A SPFx WebPart using [@pnp/graph/teams](https://pnp.github.io/pnpjs/graph/docs/teams/). It shows Channels and Tabs (with link) from a Modern Team Site connected to Microsoft Teams. +A SPFx web part using [@pnp/graph/teams](https://pnp.github.io/pnpjs/graph/docs/teams/). It shows Channels and Tabs (with link) from a Modern Team Site connected to Microsoft Teams. ## react-teams-tabs-pnpjs preview ![WebPartInAction](./assets/react-teams-tabs-pnpjs-webpart.png) diff --git a/samples/react-tenant-properties/README.md b/samples/react-tenant-properties/README.md index e94ff8b19..680c5869b 100644 --- a/samples/react-tenant-properties/README.md +++ b/samples/react-tenant-properties/README.md @@ -44,7 +44,7 @@ Only users with Tenant Admin Role are allowed to managed tenant properties. * [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) -## WebPart Properties +## Web Part Properties Property |Type|Required| comments --------------------|----|--------|---------- diff --git a/samples/react-tour-pnpjs/README.md b/samples/react-tour-pnpjs/README.md index 38a5be51b..f5e4ea79f 100644 --- a/samples/react-tour-pnpjs/README.md +++ b/samples/react-tour-pnpjs/README.md @@ -2,7 +2,7 @@ ## Summary -A SPFx WebPart using [PnP/PnPjs](https://pnp.github.io/pnpjs/), [@pnp/spfx-property-controls](https://sharepoint.github.io/sp-dev-fx-property-controls/controls/PropertyFieldCollectionData/) and [ReactTourJS](https://reactour.js.org/). +A SPFx web part using [PnP/PnPjs](https://pnp.github.io/pnpjs/), [@pnp/spfx-property-controls](https://sharepoint.github.io/sp-dev-fx-property-controls/controls/PropertyFieldCollectionData/) and [ReactTourJS](https://reactour.js.org/). It allows to create a configurable tutorial/tour of a SharePoint modern page for adoption scope. When you start the tour, a modal will be displayed, with a description of the highlighted area, and you can go to the next step or go back, thus navigating inside the page. The user will see the descriptions and will have the opportunity to preview the advice that the publisher thought for him. The property pane shows dinamically all webparts in the current page, using [PnP/PnPjs](https://pnp.github.io/pnpjs/) to make easy page tour configuration. @@ -65,7 +65,7 @@ This Web Part illustrates the following concepts on top of the SharePoint Framew * How to use [@pnp/spfx-property-controls - PropertyFieldCollectionData](https://sharepoint.github.io/sp-dev-fx-property-controls/controls/PropertyFieldCollectionData/). * How to extend with custom render [@pnp/spfx-property-controls - PropertyFieldCollectionData](https://sharepoint.github.io/sp-dev-fx-property-controls/controls/PropertyFieldCollectionData/). -* How to retrieve all SPFx WebPart in the current page using [PnP/PnPjs](https://pnp.github.io/pnpjs/) +* How to retrieve all SPFx web part in the current page using [PnP/PnPjs](https://pnp.github.io/pnpjs/) * How to include external React Component [ReactTourJS](https://reactour.js.org/) diff --git a/tutorials/tutorial-getting-started/asset-deployment-webpart/README.md b/tutorials/tutorial-getting-started/asset-deployment-webpart/README.md index 1abfb8af8..80d84f795 100644 --- a/tutorials/tutorial-getting-started/asset-deployment-webpart/README.md +++ b/tutorials/tutorial-getting-started/asset-deployment-webpart/README.md @@ -1,6 +1,6 @@ ## asset-deployment-webpart -This is where you include your WebPart documentation. +This is where you include your web part documentation. ### Building the code diff --git a/tutorials/tutorial-getting-started/hello-world-sp/README.md b/tutorials/tutorial-getting-started/hello-world-sp/README.md index 10ec0a62a..a8478d4c8 100644 --- a/tutorials/tutorial-getting-started/hello-world-sp/README.md +++ b/tutorials/tutorial-getting-started/hello-world-sp/README.md @@ -1,6 +1,6 @@ ## helloworld-webpart -This is where you include your WebPart documentation. +This is where you include your web part documentation. ### Building the code diff --git a/tutorials/tutorial-getting-started/helloworld-webpart/README.md b/tutorials/tutorial-getting-started/helloworld-webpart/README.md index 10ec0a62a..a8478d4c8 100644 --- a/tutorials/tutorial-getting-started/helloworld-webpart/README.md +++ b/tutorials/tutorial-getting-started/helloworld-webpart/README.md @@ -1,6 +1,6 @@ ## helloworld-webpart -This is where you include your WebPart documentation. +This is where you include your web part documentation. ### Building the code diff --git a/tutorials/tutorial-getting-started/jquery-webpart/README.md b/tutorials/tutorial-getting-started/jquery-webpart/README.md index ad2d34294..49c945eeb 100644 --- a/tutorials/tutorial-getting-started/jquery-webpart/README.md +++ b/tutorials/tutorial-getting-started/jquery-webpart/README.md @@ -1,6 +1,6 @@ ## jquery-webpart -This is where you include your WebPart documentation. +This is where you include your web part documentation. ### Building the code diff --git a/tutorials/tutorial-migrate-datatables/01-migrated-sewp-to-spfx/README.md b/tutorials/tutorial-migrate-datatables/01-migrated-sewp-to-spfx/README.md index dce70840e..38580007d 100644 --- a/tutorials/tutorial-migrate-datatables/01-migrated-sewp-to-spfx/README.md +++ b/tutorials/tutorial-migrate-datatables/01-migrated-sewp-to-spfx/README.md @@ -1,26 +1,26 @@ -## datatables-itrequests - -This is where you include your WebPart documentation. - -### Building the code - -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## datatables-itrequests + +This is where you include your web part documentation. + +### Building the code + +```bash +git clone the repo +npm i +npm i -g gulp +gulp +``` + +This package produces the following: + +* lib/* - intermediate-stage commonjs build artifacts +* dist/* - the bundled script, along with other resources +* deploy/* - all resources which should be uploaded to a CDN. + +### Build options + +gulp clean - TODO +gulp test - TODO +gulp serve - TODO +gulp bundle - TODO +gulp package-solution - TODO diff --git a/tutorials/tutorial-migrate-datatables/02-added-configuration/README.md b/tutorials/tutorial-migrate-datatables/02-added-configuration/README.md index dce70840e..38580007d 100644 --- a/tutorials/tutorial-migrate-datatables/02-added-configuration/README.md +++ b/tutorials/tutorial-migrate-datatables/02-added-configuration/README.md @@ -1,26 +1,26 @@ -## datatables-itrequests - -This is where you include your WebPart documentation. - -### Building the code - -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## datatables-itrequests + +This is where you include your web part documentation. + +### Building the code + +```bash +git clone the repo +npm i +npm i -g gulp +gulp +``` + +This package produces the following: + +* lib/* - intermediate-stage commonjs build artifacts +* dist/* - the bundled script, along with other resources +* deploy/* - all resources which should be uploaded to a CDN. + +### Build options + +gulp clean - TODO +gulp test - TODO +gulp serve - TODO +gulp bundle - TODO +gulp package-solution - TODO diff --git a/tutorials/tutorial-migrate-datatables/03-transformed-js-to-typescript/README.md b/tutorials/tutorial-migrate-datatables/03-transformed-js-to-typescript/README.md index dce70840e..38580007d 100644 --- a/tutorials/tutorial-migrate-datatables/03-transformed-js-to-typescript/README.md +++ b/tutorials/tutorial-migrate-datatables/03-transformed-js-to-typescript/README.md @@ -1,26 +1,26 @@ -## datatables-itrequests - -This is where you include your WebPart documentation. - -### Building the code - -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## datatables-itrequests + +This is where you include your web part documentation. + +### Building the code + +```bash +git clone the repo +npm i +npm i -g gulp +gulp +``` + +This package produces the following: + +* lib/* - intermediate-stage commonjs build artifacts +* dist/* - the bundled script, along with other resources +* deploy/* - all resources which should be uploaded to a CDN. + +### Build options + +gulp clean - TODO +gulp test - TODO +gulp serve - TODO +gulp bundle - TODO +gulp package-solution - TODO diff --git a/tutorials/tutorial-migrate-fullcalendar/01-migrated-sewp-to-spfx/README.md b/tutorials/tutorial-migrate-fullcalendar/01-migrated-sewp-to-spfx/README.md index ef0459a98..9179442e9 100644 --- a/tutorials/tutorial-migrate-fullcalendar/01-migrated-sewp-to-spfx/README.md +++ b/tutorials/tutorial-migrate-fullcalendar/01-migrated-sewp-to-spfx/README.md @@ -1,26 +1,26 @@ -## fullcalendar-taskscalendar - -This is where you include your WebPart documentation. - -### Building the code - -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## fullcalendar-taskscalendar + +This is where you include your web part documentation. + +### Building the code + +```bash +git clone the repo +npm i +npm i -g gulp +gulp +``` + +This package produces the following: + +* lib/* - intermediate-stage commonjs build artifacts +* dist/* - the bundled script, along with other resources +* deploy/* - all resources which should be uploaded to a CDN. + +### Build options + +gulp clean - TODO +gulp test - TODO +gulp serve - TODO +gulp bundle - TODO +gulp package-solution - TODO diff --git a/tutorials/tutorial-migrate-fullcalendar/02-added-configuration/README.md b/tutorials/tutorial-migrate-fullcalendar/02-added-configuration/README.md index ef0459a98..9179442e9 100644 --- a/tutorials/tutorial-migrate-fullcalendar/02-added-configuration/README.md +++ b/tutorials/tutorial-migrate-fullcalendar/02-added-configuration/README.md @@ -1,26 +1,26 @@ -## fullcalendar-taskscalendar - -This is where you include your WebPart documentation. - -### Building the code - -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## fullcalendar-taskscalendar + +This is where you include your web part documentation. + +### Building the code + +```bash +git clone the repo +npm i +npm i -g gulp +gulp +``` + +This package produces the following: + +* lib/* - intermediate-stage commonjs build artifacts +* dist/* - the bundled script, along with other resources +* deploy/* - all resources which should be uploaded to a CDN. + +### Build options + +gulp clean - TODO +gulp test - TODO +gulp serve - TODO +gulp bundle - TODO +gulp package-solution - TODO diff --git a/tutorials/tutorial-migrate-fullcalendar/03-transformed-js-to-typescript/README.md b/tutorials/tutorial-migrate-fullcalendar/03-transformed-js-to-typescript/README.md index ef0459a98..9179442e9 100644 --- a/tutorials/tutorial-migrate-fullcalendar/03-transformed-js-to-typescript/README.md +++ b/tutorials/tutorial-migrate-fullcalendar/03-transformed-js-to-typescript/README.md @@ -1,26 +1,26 @@ -## fullcalendar-taskscalendar - -This is where you include your WebPart documentation. - -### Building the code - -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## fullcalendar-taskscalendar + +This is where you include your web part documentation. + +### Building the code + +```bash +git clone the repo +npm i +npm i -g gulp +gulp +``` + +This package produces the following: + +* lib/* - intermediate-stage commonjs build artifacts +* dist/* - the bundled script, along with other resources +* deploy/* - all resources which should be uploaded to a CDN. + +### Build options + +gulp clean - TODO +gulp test - TODO +gulp serve - TODO +gulp bundle - TODO +gulp package-solution - TODO diff --git a/tutorials/tutorial-migrate-fullcalendar/04-replaced-jquery-ajax-with-spfx/README.md b/tutorials/tutorial-migrate-fullcalendar/04-replaced-jquery-ajax-with-spfx/README.md index ef0459a98..9179442e9 100644 --- a/tutorials/tutorial-migrate-fullcalendar/04-replaced-jquery-ajax-with-spfx/README.md +++ b/tutorials/tutorial-migrate-fullcalendar/04-replaced-jquery-ajax-with-spfx/README.md @@ -1,26 +1,26 @@ -## fullcalendar-taskscalendar - -This is where you include your WebPart documentation. - -### Building the code - -```bash -git clone the repo -npm i -npm i -g gulp -gulp -``` - -This package produces the following: - -* lib/* - intermediate-stage commonjs build artifacts -* dist/* - the bundled script, along with other resources -* deploy/* - all resources which should be uploaded to a CDN. - -### Build options - -gulp clean - TODO -gulp test - TODO -gulp serve - TODO -gulp bundle - TODO -gulp package-solution - TODO +## fullcalendar-taskscalendar + +This is where you include your web part documentation. + +### Building the code + +```bash +git clone the repo +npm i +npm i -g gulp +gulp +``` + +This package produces the following: + +* lib/* - intermediate-stage commonjs build artifacts +* dist/* - the bundled script, along with other resources +* deploy/* - all resources which should be uploaded to a CDN. + +### Build options + +gulp clean - TODO +gulp test - TODO +gulp serve - TODO +gulp bundle - TODO +gulp package-solution - TODO