Skip to content

Commit c277815

Browse files
committed
Updated files related on the SP2016 Feature Pack 2 release.
1 parent 9dc385a commit c277815

8 files changed

+78
-6
lines changed

docs/spfx/enterprise-guidance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ What you cannot backup is the actual solution artifacts such as script bundles a
161161

162162
## SharePoint Framework Roadmap
163163

164-
The SharePoint Framework reached General Availability (GA) in February 2017. General Availability means that IT and developers can supportably use SharePoint Framework in production. Beyond General Availability, we would expect that the set of scenarios where we would see SharePoint Framework-based components are built and used will expand beyond web parts scenarios, and into areas like list and site customizations. For more information about the SharePoint Framework see the dedicated [SharePoint Framework Roadmap article](https://dev.office.com/sharepoint/docs/spfx/roadmap). Also, the SharePoint team is looking to bring the SharePoint Framework to SharePoint 2016 on-premises during 2017, as part of a future Feature Pack.
164+
The SharePoint Framework reached General Availability (GA) in February 2017. General Availability means that IT and developers can supportably use SharePoint Framework in production. Beyond General Availability, we would expect that the set of scenarios where we would see SharePoint Framework-based components are built and used will expand beyond web parts scenarios, and into areas like list and site customizations. For more information about the SharePoint Framework see the dedicated [SharePoint Framework Roadmap article](https://dev.office.com/sharepoint/docs/spfx/roadmap). SharePoint Framework client-side web parts are also available in on-premises with SharePoint 2016 Feature Pack 2.
165165

166166
Major changes or introduction of new major features will be announced through the Office 365 Message Center, found in your tenant admin - something that an Office 365 administrator already should have on their daily routine to check. Another important resource is the [Office Developer blog](http://dev.office.com/blogs) where you will find even more details and updates.
167167

docs/spfx/known-issues-and-common-questions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,16 @@ You should update your Yeoman template packages. We have updated certification c
1919

2020
- *Date - 6th of June*
2121

22-
SharePoint Extensions with additional customizations capabilities for the SharePoint Online is now available for dev preview. We do not have public GA date currently. You can start learning how to build these extensions reading following tutorials.
22+
SharePoint Extensions with additional customizations capabilities for the SharePoint Online is now available as Release Candiate release. We do not have public GA date currently. You can start learning how to build these extensions reading following tutorials.
2323

2424
* [Getting started with SharePoint Framework Extensions](http://aka.ms/spfx-extensions)
2525

2626
**Will SharePoint Framework be available in on-premises?**
2727

2828
- *Date - 6th of June*
29+
- *Updated - 12th of September*
2930

30-
SharePoint Framework client-side web parts will be released to SharePoint 2016 as part of the Feature Pack 2 (FP2).
31+
SharePoint Framework client-side web parts are now available as part of the SharePoint 2016 Feature Pack 2 (FP2).
3132

3233
## Additional resources
3334
Please use following resources to provide feedback, comments and questions towards SharePoint engineering.

docs/spfx/roadmap.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ First release of the SharePoint Framework will contain support for client-side w
1010
- Similar feature capabilities as in SharePoint Online
1111
- Target is to provide common development platform across on-premises and the cloud
1212
- Leveraging modern toolchain and open source on on-premises environments
13-
- Targeting SharePoint 2016 version during calendar year 2017
13+
14+
> SharePoint 2016 support for client-side web parts was shipped with SharePoint 2016 Feature Pack 2 during September 2017.
1415
1516
## General improvements
1617

docs/spfx/set-up-your-development-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Enter the following command to install the Yeoman SharePoint generator:
6565
```
6666
npm install -g @microsoft/generator-sharepoint
6767
```
68-
>**Note:** Yeoman generator for SharePoint is targeted to get deployed globally with the initial General Availability (GA) version. There are some known issues if it's installed locally to the project, which are planned to be addressed post GA.
68+
>**Note:** Yeoman generator for SharePoint can be installed both globally and locally. In this case we are installing the Yeoman generator for SharePoint to be available globally.
6969
7070

7171
## Optional tools

docs/spfx/sharepoint-2016-support.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# SharePoint Framework development with SharePoint 2016 Feature Pack 2
2+
3+
SharePoint 2016 Feature Pack 2 support SharePoint Framework client-side web parts in classic SharePoint pages.
4+
5+
Introduction to SharePoint Framework development in SharePoint 2016 Feature Pack is also covered in following video at [SharePoint PnP YouTube Channel](https://www.youtube.com/watch?v=LGLMxnmHk6U&list=PLR9nK3mnD-OXZbEvTEPxzIOMGXj_aZKJG).
6+
7+
<a href="https://www.youtube.com/watch?v=LGLMxnmHk6U&list=PLR9nK3mnD-OXZbEvTEPxzIOMGXj_aZKJG">
8+
<img src="../../images/spfx-fp2-youtube-video.png" alt="Screenshot of the YouTube video player for this tutorial" />
9+
</a>
10+
11+
## When to use which SharePoint Framework version?
12+
13+
Since SharePoint Online and SharePoint 2016 has different release cycle for the new capabilities, they do support different capabilities also for the SharePoint Framework. SharePoint Online is always using the latest version of the SharePoint Framework, but SharePoint 2016 will support the version, which is matching server-side dependencies of the deployed packages.
14+
15+
SharePoint 2016 Feature Pack 2 has support for the SharePoint Framework client-side web parts hosted in the classic SharePoint pages with SharePoint Framework v1.0. This means that when you are targeting your customization to SharePoint 2016 platform, you'll need to use SharePoint Framework v1.0.2 version due server-side version dependency.
16+
17+
If you are planning to use same client-side web parts in both SharePoint 2016 and in SharePoint Online, you will need to use the SharePoint Framework v1.0.2 as your baseline version to ensure that the web part works in both environments.
18+
19+
## Installing SharePoint Framework version for SP2016 development
20+
21+
You should ensure that you are using the right version of SharePoint Framework in your development machine. You can check the currently globally installed SharePoint Framework Yeoman template package version by executing following command.
22+
23+
```
24+
npm list -g --depth 0
25+
```
26+
27+
This will list the globally installed packages, including their versions. You can uninstall newer version by using following command.
28+
29+
```
30+
npm uninstall -g @microsoft/generator-sharepoint
31+
```
32+
33+
To install v1.0.2 version of the SharePoint Framework Yeoman templates, you can execute following command.
34+
35+
```
36+
npm install -g @microsoft/[email protected]
37+
```
38+
39+
## Hosting your SharePoint Framework solution for on-premises deployment
40+
41+
Getting SharePoint Framework client-side web parts deployed to on-premises will require two distinct actions.
42+
43+
- Deployment of the solution package to SharePoint app catalog
44+
- Hosting JavaScript files in centralized ___location
45+
46+
You can host JavaScript files in any suitable ___location for you depending on the environment details. These files can be for example hosted in following locations.
47+
48+
- **Azure CDN** - Similar setup as with SharePoint Online. Does require end users to have Internet connectivity
49+
- **Local server in corporate network** - Server hosting the JavaScript files for the corporate network. This can be using whatever technology as long as files are accessible with http requests.
50+
- **SharePoint 2016** - You can also host your files in the local SharePoint farm. You can for example define a standardized site in your farm where all the SharePoint Framework assets are being hosted. Notice though that by default .json files are not allowed to be uploaded to SharePoint 2016 libraries, so farm level settings will need to be adjusted for this option.
51+
52+
> You can find more details on the blocked file types in SharePoint 2016 from following support article: [Types of files that cannot be added to a list or library](https://support.office.com/en-us/article/Types-of-files-that-cannot-be-added-to-a-list-or-library-30be234d-e551-4c2a-8de8-f8546ffbf5b3#ID0EAADAAA=2016)
53+
54+
## Development environment considerations
55+
56+
When you are developing SharePoint Framework client-side web parts, you should have normally Internet connectivity to access npm packages. This is required when solutions are being scaffold using SharePoint Framework Yeoman templates.
57+
58+
If Internet access is not available for the development machines, you can also setup local on-premises registry for needed npm packages. This does however require additional software and significant amount of work to operation and to update based on new versions and packages in actual npm gallery.
59+
60+
> [Team-based development on the SharePoint Framework](team-based-development-on-sharepoint-framework.md) guidance includes different options around the development environment setup also when you might need to support multiple SharePoint Framework versions.
61+
62+
## How to determine which SharePoint Framework version was used for a solution?
63+
64+
If you have already existing SharePoint Framework solutions and you'd like to confirm the used SharePoint Framework version for them, you'll need to confirm this potentially from following locations.
65+
66+
- **.yo-rc.json** file in solution root folder defines used SharePoint Framework Yeoman template version when the solution was created.
67+
- **package.json** file in the solution root folder contains references to versions when the solution was created.
68+
- **npm-shrinkwrap.json** file in the solution root folder will contain information on the exact versions, if you have used the `npm shrinkwrap` command for the solution to lock-down the exact versions.
69+
-- **package.json** file in *node_modules\@microsoft/sp-webpart-base* folder contains a *version* attribute matching used SharePoint Framework version, if you have installed packages to your solution.

docs/spfx/sharepoint-framework-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview of the SharePoint Framework
22

3-
The SharePoint Framework (SPFx) is a page and web part model that provides full support for client-side SharePoint development, easy integration with SharePoint data, and support for open source tooling. With the SharePoint Framework, you can use modern web technologies and tools in your preferred development environment to build productive experiences and apps that are responsive and mobile-ready from day one. The SharePoint Framework works for SharePoint Online and soon also for on-premises (SharePoint 2016 Feature Pack 2).
3+
The SharePoint Framework (SPFx) is a page and web part model that provides full support for client-side SharePoint development, easy integration with SharePoint data, and support for open source tooling. With the SharePoint Framework, you can use modern web technologies and tools in your preferred development environment to build productive experiences and apps that are responsive and mobile-ready from day one. The SharePoint Framework works for SharePoint Online and also for on-premises (SharePoint 2016 Feature Pack 2).
44

55
Key features of the SharePoint Framework include:
66

images/spfx-fp2-youtube-video.png

63.8 KB
Loading

misc/SharePointDocumentationToc.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
<Item text="Tools and libraries" url="spfx/tools-and-libraries" SEODescription="Learn about the tools and libriaries you will need to use to build your SharePoint Framework solutions."/>
88
<Item text="Set up your Office 365 tenant" url="spfx/set-up-your-developer-tenant" SEODescription="Set up an Office 365 tenant so that you can test and debug your SharePoint client-side web parts" />
99
<Item text="Set up your development environment" url="spfx/set-up-your-development-environment" SEODescription="Set up and configure your development environment to build SharePoint client-side web parts" />
10+
<Item text="SharePoint 2016 support" url="spfx/sharepoint-2016-support" SEODescription="SharePoint Framework development with SharePoint 2016 Feature Pack 2" />
1011
<Item text="Debug solutions with VS Code" url="spfx/debug-in-vscode" SEODescription="Debug SharePoint Framework solutions in Visual Studio Code" />
1112
<Item text="Enterprise Guidance" url="spfx/enterprise-guidance" SEODescription="SharePoint Framework Enterprise architecture and development guidance." />
1213
<Item text="Team-based development" url="spfx/team-based-development-on-sharepoint-framework" SEODescription="Team-based development on SharePoint Framework." />

0 commit comments

Comments
 (0)