Skip to content

Commit cbe1375

Browse files
committed
Updates for GA release
1 parent e9da5ea commit cbe1375

37 files changed

+100
-171
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ docs
2020
```
2121
At this time, contributions are accepted for:
2222

23-
* SharePoint Framework Developer Preview
23+
* SharePoint Framework
2424
* SharePoint Webhooks
2525

2626
### SPFx Folder

docs/apis/webhooks/get-started-webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ Now add a file to the Documents library and test if you get a notification from
450450
* Go to the **Documents** library. It will be named **Shared Documents** library in your default site collection.
451451
* Add a new file.
452452
* Go to Visual Studio and wait for the breakpoint to be hit.
453-
* In preview, the wait time may vary from a few seconds up to five minutes. When the breakpoint is hit, the webhook receiver has just received a notification from SharePoint.
453+
* Wait time may vary from a few seconds up to five minutes. When the breakpoint is hit, the webhook receiver has just received a notification from SharePoint.
454454
* Choose **F5** to continue.
455455
* To see the notification data, look in the **Output** window for the following entries, since you added the notification data into the trace log:
456456

docs/spfx/roadmap.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22

33
First release of the SharePoint Framework will contain support for client-side web parts. This is however just a start on the journey for providing additional modern customization capabilities to SharePoint. This article lists the different areas which are in our backlog for the future releases of SharePoint Framework.
44

5-
> Notice. This is a list areas which SharePoint engineering is having in the backlog and are looking into. This does **NOT** mean that all of them will be necessarily delivered, but we are looking for getting items and topics from this list gradually released with the future releases of SharePoint Framework.
5+
> Notice. This is a list of areas which SharePoint engineering is having in the backlog and are looking into. This does **NOT** mean that all of them will be necessarily delivered, but we are looking for getting items and topics from this list gradually released with the future releases of SharePoint Framework.
66
77
## On-premises support
88

99
- Shipping as part of Feature Pack
1010
- Similar feature capabilities as in SharePoint Online
1111
- Target is to provide common development platform across on-premises and the cloud
12-
- Getting head-start on your cloud migration
1312
- Leveraging modern toolchain and open source on “legacy” environments
1413
- Targeting SharePoint 2016 version during calendar year 2017
1514

@@ -40,26 +39,16 @@ First release of the SharePoint Framework will contain support for client-side w
4039
- Streamlined approval experience: no need to know who your tenant admin is anymore
4140
- Owner initiate the approval process
4241
- Tenant admin gets automatically notified
43-
- Settings to control the default experience:
44-
- auto approve for a set of people (e.g. “trusted team”)
45-
- approve or deny after XX days
46-
47-
- ALM REST APIs
48-
- Deploy packages
49-
- Activate the app
50-
- Delete the app
51-
- Upgrade the app
42+
- Settings to control the default experience around approval process
5243

44+
- ALM REST APIs - Deploy, activate, delete and upgrade apps and add-ins
5345
- ALM REST APIs targeted to support *everything* in the App Catalog, including add-ins
5446
- Automatic CDN hosting for code
5547
- Package JavaScript bundle into app package, which is automatically then deployed to a library that gets hosted on your tenant Office 365 CDN
5648

5749

5850
## Developer Experience
59-
- SharePoint Framework Workbench 2.0: Development story beyond web parts
60-
- "code parts", Apps and Pages support
61-
- "Connect to SharePoint" for easy switching between local and online workbench
62-
51+
- SharePoint Framework Workbench 2.0: Development story beyond web parts with support for new componen types on top of client-side web parts
6352
- Tool Chain Components
6453
- Additional Yeoman Templates
6554

@@ -68,8 +57,6 @@ First release of the SharePoint Framework will contain support for client-side w
6857
- List level: custom view item, edit item, delete item, add item
6958
- Page level: assign an app to a page to a full custom page experience
7059
- Mobile
71-
- Like everything in the framework: responsive OOB
72-
- SharePoint Mobile app either launches an external app or responsive renders of the app
7360

7461
## Additional resources
7562
Please use following resources to stay up to date on the new releases and capabilities being released for SharePoint Framework.

docs/spfx/set-up-your-developer-tenant.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Set up your Office 365 tenant
22

3-
>**Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments.
4-
53
To build and deploy client-side web parts using the preview release of the SharePoint Framework, you will need an Office 365 tenant with [First Release](https://support.office.com/en-us/article/Set-up-the-Standard-or-First-Release-options-in-Office-365-3b3adfa4-1777-4ff0-b606-fb8732101f47) options enabled.
64

75
## Sign up for an Office 365 tenant

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Set up your SharePoint client-side web part development environment
22

3-
>**Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments.
4-
53
You can use Visual Studio, or your own custom development environment to build SharePoint client-side web parts. You can use a Mac, PC, or Linux.
64

75
>**Note:** Before following the steps in this article, be sure to [Set up your Office 365 Tenant](./set-up-your-developer-tenant).

docs/spfx/sharepoint-framework-overview.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Overview of the SharePoint Framework
22

3-
>**Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments.
4-
53
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 on-premises and SharePoint Online.
64

75
Key features of the SharePoint Framework include:

docs/spfx/team-based-development-on-sharepoint-framework.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@ SharePoint Framework is a new development model for building SharePoint customiz
44

55
SharePoint Framework is a development model, and despite the differences in the underlying technology, the same concepts apply when using it for building solutions, as to other development models SharePoint developers used in the past. Developers use the SharePoint Framework toolchain to build and test their solutions and once ready, they hand over the solution package to be deployed on the SharePoint tenant for further testing and release.
66

7-
SharePoint Framework consists of a few different packages. These packages, each in its own specific version, make up a release of the SharePoint Framework. For example the Release Candidate (RC0) of the SharePoint Framework consists of the following package versions:
8-
9-
- @microsoft/sp-client-base v0.7.0
10-
- @microsoft/sp-client-preview v0.9.0
11-
- @microsoft/sp-core-library v0.1.2
12-
- @microsoft/sp-webpart-base v0.4.0
13-
- @microsoft/sp-build-web v0.9.0
14-
- @microsoft/sp-module-interfaces v0.7.0
15-
- @microsoft/sp-webpart-workbench v0.8.0
7+
SharePoint Framework consists of a few different packages. These packages, each in its own specific version, make up a release of the SharePoint Framework. For example the General Availability release of the SharePoint Framework consists of the following package versions:
8+
9+
- @microsoft/sp-client-base v1.0.0
10+
- @microsoft/sp-core-library v1.0.0
11+
- @microsoft/sp-webpart-base v1.0.0
12+
- @microsoft/sp-build-web v1.0.0
13+
- @microsoft/sp-module-interfaces v1.0.0
14+
- @microsoft/sp-webpart-workbench v1.0.0
1615

1716
For a project to target a specific release of the SharePoint Framework it has to reference all the different packages in the correct versions. When scaffolding new projects, the SharePoint Framework Yeoman generator automatically adds the necessary references to the package from the corresponding release of the SharePoint Framework. But when upgrading the project to a newer version of the SharePoint Framework developers have to pay extra attention to correctly update version numbers of the SharePoint Framework packages.
1817

docs/spfx/toolchain/extending-webpack-in-build-pipeline.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Extending webpack in the SharePoint Framework toolchain
22

3-
>**Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments.
4-
53
[Webpack](https://webpack.github.io/) is a JavaScript module bundler that takes your JavaScript files and its dependencies and generates one or more JavaScript bundles so you can load different bundles for different scenarios.
64

75
The framework tool chain uses CommonJS for bundling. This enables you to define modules and where you want to use them. The tool chain also uses SystemJS, a universal module loader, to load your modules. This helps you to scope your web parts by making sure that each web part is executed in its own namespace.

docs/spfx/toolchain/integrate-gulp-tasks-in-build-pipeline.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Integrate gulp tasks in SharePoint Framework toolchain
22

3-
>**Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments.
4-
53
SharePoint client-side development tools use [gulp](http://gulpjs.com/) as the build process task runner to:
64

75
* Bundle and minify JavaScript and CSS files.

docs/spfx/toolchain/sharepoint-framework-toolchain.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# SharePoint Framework Toolchain
22

3-
>**Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments.
4-
53
## Overview
64
The SharePoint Framework toolchain is the set of build tools, framework packages, and other items that manage building and deploying your client side projects. The toolchain helps you build client-side components like web parts. It also helps you test them in your local development environment with tools such as the SharePoint Workbench. And you can use the toolchain to package and deploy to SharePoint. The toolchain also provides you with a set of build commands that help you to complete key build tasks such as code compilation, packaging the client-side project into a SharePoint app package and more.
75

@@ -19,8 +17,6 @@ The following packages are in the SharePoint Framework:
1917

2018
* [@microsoft/sp-client-base](https://www.npmjs.com/package/@microsoft/sp-client-base) - Defines the core libraries for client-side applications built using the SharePoint Framework
2119

22-
* [@microsoft/sp-client-preview](https://www.npmjs.com/package/@microsoft/sp-client-preview) - Contains SharePoint Framework libraries that are still under development. Once they are finalized, they will be refactored into separate npm packages.
23-
2420
* [@microsoft/sp-webpart-workbench](https://www.npmjs.com/package/@microsoft/sp-webpart-workbench) - The SharePoint Workbench is a standalone environment for testing and debugging client-side web parts.
2521

2622
* [@microsoft/sp-module-loader](https://www.npmjs.com/package/@microsoft/sp-module-loader) - A module loader that manages versioning and loading of client-side components, web parts, and other assets. It also provides basic diagnostic services. It is built on familiar standards such as SystemJS and WebPack, and is the first part of the SharePoint Framework to load on a page.
@@ -82,18 +78,22 @@ Below is the `package.json` of the [helloworld-webpart](web-parts/get-started/bu
8278
"node": ">=0.10.0"
8379
},
8480
"dependencies": {
85-
"@microsoft/sp-client-base": "~0.1.12",
86-
"@microsoft/sp-client-preview": "~0.1.12"
81+
"@microsoft/sp-client-base": "~1.0.0",
82+
"@microsoft/sp-core-library": "~1.0.0",
83+
"@microsoft/sp-webpart-base": "~1.0.0",
84+
"@types/webpack-env": ">=1.12.1 <1.14.0"
8785
},
8886
"devDependencies": {
89-
"@microsoft/sp-build-web": "~0.4.32",
90-
"@microsoft/sp-module-interfaces": "~0.1.8",
91-
"@microsoft/sp-webpart-workbench": "~0.1.12",
92-
"gulp": "~3.9.1"
87+
"@microsoft/sp-build-web": "~1.0.0",
88+
"@microsoft/sp-module-interfaces": "~1.0.0",
89+
"@microsoft/sp-webpart-workbench": "~1.0.0",
90+
"gulp": "~3.9.1",
91+
"@types/chai": ">=3.4.34 <3.6.0",
92+
"@types/mocha": ">=2.2.33 <2.6.0"
9393
},
9494
"scripts": {
9595
"build": "gulp bundle",
96-
"clean": "gulp nuke",
96+
"clean": "gulp clean",
9797
"test": "gulp test"
9898
}
9999
}

0 commit comments

Comments
 (0)