Skip to content

Commit 1156fad

Browse files
authored
Merge pull request SharePoint#277 from chakkaradeep/staging
Updated docs to latest drop changes.
2 parents 478222c + 9e6bcd0 commit 1156fad

7 files changed

+40
-32
lines changed

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

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Set up your Office 365 developer tenant
1+
# Set up your Office 365 tenant
22

33
>**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.
44
5-
To build and deploy client-side web parts using the preview release of the SharePoint Framework, you will need an Office 365 Developer Tenant. Your tenant must be a **developer tenant**, not just a site collection.
5+
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.
66

7-
## Sign up for an Office 365 Developer Tenant
8-
If you already have an Office 365 Developer Tenant, see [create your app catalog site](#create-app-catalog-site).
7+
## Sign up for an Office 365 tenant
8+
If you already have an Office 365 tenant, see [create your app catalog site](#create-app-catalog-site). Make sure you have [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.
99

10-
If you don't have one, sign up for the [Office Developer Program](https://profile.microsoft.com/RegSysProfileCenter/wizardnp.aspx?wizid=14b845d0-938c-45af-b061-f798fbb4d170&lcid=1033). You will receive a welcome mail with a link to sign up for an Office 365 Developer Tenant.
10+
If you don't have one, sign up for the [Office Developer Program](https://profile.microsoft.com/RegSysProfileCenter/wizardnp.aspx?wizid=14b845d0-938c-45af-b061-f798fbb4d170&lcid=1033). You will receive a welcome mail with a link to sign up for an Office 365 Developer Tenant. First Release options are enabled already for your Office 365 Developer Tenant.
1111

1212
>**Note:** Make sure that you are signed out of any existing Office 365 tenants before you sign up.
1313
@@ -68,7 +68,7 @@ In order to use the features of the SharePoint Framework, you will need to set u
6868
* Choose **OK** to create the column.
6969

7070
## Put the SharePoint workbench in the document library
71-
You need the SharePoint workbench on your developer site to test your web parts on SharePoint.
71+
You need the SharePoint Workbench on your developer site to test your web parts on SharePoint. This procedure uses the default document library in your site collection. This will be called **Documents** in the left navigation.
7272

7373
* Download the [workbench.aspx](https://github.com/SharePoint/sp-dev-docs/blob/master/workbench.aspx) file to your local computer. To do this:
7474
- Open the context menu (right-click) on the file content in the middle of the page and choose **Save Target As** or **Save Link As** (depending on your browser) to save the file as **workbench.aspx** to your local computer.
@@ -78,10 +78,14 @@ You need the SharePoint workbench on your developer site to test your web parts
7878

7979
## Troubleshooting
8080

81+
You will get an error If you are using a SharePoint site that was provisioned using a self-service site creation. We recommend using a developer site collection or a SharePoint site that was not created using a self-service site creation.
82+
8183
If you get the following exception when moving to the workbench.aspx page:
8284

83-
- "The requested operation is part of an experimental feature that is not supported in the current environment. The requested operation is part of an experimental feature that is not supported in the current environment."
84-
- You are not using a developer tenant. You might be using a first release or normal tenant
85+
```
86+
"The requested operation is part of an experimental feature that is not supported in the current environment. The requested operation is part of an experimental feature that is not supported in the current environment."
87+
```
88+
Then, you are not using a tenant with First Release options enabled. You might be using a normal tenant
8589

8690
During developer preview also "Custom Script" feature will need to be enabled in site collections where you will be using the client-side web parts.
8791

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
55
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.
66

7+
>**Note:** Before following the steps in this article, be sure to [Set up your Office 365 Tenant](../../set-up-your-developer-tenant).
8+
79
## Install developer tools
810

911
### NodeJS

docs/spfx/web-parts/basics/use-visual-studio.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,6 @@ The first step is to create the SharePoint client-side project. Use the Yeoman S
4646
4747
### Import your project into Visual Studio
4848
49-
There are two ways to open your client-side project in Visual Studio. Use the steps that work best for you.
50-
51-
If opening the **.njsproj** doesn't work for you, you can try importing the client-side solution project into Visual Studio.
52-
53-
#### Open Visual Studio and create a new project
54-
5549
1. In the **New Project** dialog box, select the **Templates > Other languages > TypeScript >Node.js** and then **From Existing Node.js code** project template.
5650
Name the project the same name as your SharePoint client-side project, that is, *hello-vs-webpart*. Choose the ___location of the client-side project for the ___location, and choose **OK**.
5751
@@ -101,7 +95,17 @@ In the project properties, change the following properties to their correspondin
10195
10296
### Build and debug the project
10397
104-
Your client-side project is now set up to work with Visual Studio. Press F5 to build and debug your project in your favorite browser.
98+
Your client-side project is now set up to work with Visual Studio.
99+
100+
To preview your web part, build and run it on a local web server. The client-side toolchain uses HTTPS endpoint by default. However, since a default certificate is not configured for the local dev environment, your browser will report a certificate error. The SPFx toolchain comes with a developer certificate that you can install for building web parts.
101+
102+
To install the developer certificate for use with SPFx development, switch to your console, make sure you are still in the **helloworld-webpart** directory and enter the following command:
103+
104+
```
105+
gulp trust-dev-cert
106+
```
107+
108+
Press F5 to build and debug your project in your favorite browser.
105109
106110
#### Notes on debugging
107111
@@ -120,6 +124,7 @@ All major browsers have developer tools:
120124
The SharePoint Framework comes with a set of gulp tasks to simplify packaging your client-side solution and uploading your assets to CDN. You can use the following commands to access them:
121125
122126
```
127+
gulp trust-dev-cert
123128
gulp package-solution
124129
gulp deploy-azure-storage
125130
```

docs/spfx/web-parts/get-started/build-a-hello-world-web-part.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,32 +58,33 @@ When the scaffold is complete, you should see the following message indicating a
5858

5959
For information about troubleshooting any errors, see [Known issues](../basics/known-issues).
6060

61-
### Using your favorite Code Editor/IDE
61+
### Using your favorite Code Editor
6262
Because the SharePoint client-side solution is HTML/TypeScript based, you can use any code editor or IDE that supports client-side development to build your web part, such as:
6363

6464
* [Visual Studio Code](https://code.visualstudio.com/)
6565
* [Sublime](https://www.sublimetext.com/)
6666
* [Atom](https://atom.io)
6767
* [Webstorm](https://www.jetbrains.com/webstorm)
6868

69-
>**Note:** This article uses Visual Studio code in the steps and examples. You can use any IDE that you prefer.
70-
71-
### Using Visual Studio 2015
72-
Currently, support for SharePoint client-side projects in Visual Studio is available through NodeJS Tools for Visual Studio. For more information, see [Use Visual Studio to develop web parts](../basics/use-visual-studio).
69+
>**Note:** This article uses Visual Studio code in the steps and examples. You can use any code editor that you prefer.
7370
7471
## Preview the web part
75-
To preview your web part, build and run it on a local web server.
72+
To preview your web part, build and run it on a local web server. The client-side toolchain uses HTTPS endpoint by default. However, since a default certificate is not configured for the local dev environment, your browser will report a certificate error. The SPFx toolchain comes with a developer certificate that you can install for building web parts.
73+
74+
To install the developer certificate for use with SPFx development, switch to your console, make sure you are still in the **helloworld-webpart** directory and enter the following command:
75+
76+
```
77+
gulp trust-dev-cert
78+
```
7679

77-
Switch to your console, make sure you are still in the **helloworld-webpart** directory and enter the following command to build and preview your web part:
80+
Now that we have installed the developer certificate, enter the following command in the console to build and preview your web part:
7881

7982
```
8083
gulp serve
8184
```
8285

8386
This command will execute a series of gulp tasks to create a local, Node-based HTTPS server on 'localhost:4321' and launch your default browser to preview web parts from your local dev environment.
8487

85-
The client-side toolchain uses HTTPS endpoint by default. However, since a default certificate is not configured for the local dev environment, your browser will report a certificate error. Depending on the browser you are using, you will need to add exception (for example, Mozilla Firefox) or click Advanced and select to proceed to the website (for example, Microsoft Edge or Google Chrome).
86-
8788
![Gulp serve web part project](../../../../images/helloworld-wp-gulp-serve.png)
8889

8990
SharePoint client-side development tools use [gulp](http://gulpjs.com/) as the task runner to handle build process tasks such as:

docs/spfx/web-parts/get-started/connect-to-sharepoint.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,7 @@ You should see the following in the web part:
7777

7878
Go to **workbench.aspx** hosted in SharePoint. The full URL is https://your-sharepoint-site-url/Shared%20Documents/workbench.aspx.
7979

80-
By default, your browser is configured not to load scripts from localhost. Workbench will notify you if that is the case as shown in the following image. This is due to loading scripts over HTTP while connected to a page via HTTPS.
81-
82-
![Load unsafe scripts to run scripts from localhost](../../../../images/sp-workbench-o365-unsface-scripts.png)
83-
84-
To execute local scripts, in the Chrome browser, click the grey shield in the right side of the address bar to load unsafe scripts.
85-
86-
![Allow browser to load unsafe scripts to run scripts from localhost](../../../../images/chrome-load-unsafe-scripts.png)
80+
>**Note:** If you do not have the SPFx developer certificate installed, then Workbench will notify you that it is configured not to load scripts from localhost. Execute `gulp trust-dev-cert` command in your project directory console to install the developer certificate.
8781
8882
You should now see your SharePoint site URL in the web part now that page context is available to the web part.
8983

docs/spfx/web-parts/get-started/serve-your-web-part-in-a-sharepoint-page.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ This will deploy the client-side solution package. Since this is a full trust cl
8888

8989
Choose **Deploy**
9090

91+
>**Note:** If package deployment fails, then you may be using a normal tenant. Make sure you [set up your Office 365 tenant](../../set-up-your-developer-tenant) to have First Release options enabled or use a Office 365 Developer Tenant.
92+
9193
## Install the client-side solution on your site
9294

9395
Go to your developer site collection.

misc/SharePointDocumentationToc.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<Item text="SharePoint Framework" url="spfx" SEODescription="">
44
<Item text="Overview" url="spfx/sharepoint-framework-overview" SEODescription="The SharePoint Framework provides a modern developer experience for extending SharePoint."/>
55
<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."/>
6-
<Item text="Set up your Office 365 developer tenant" url="spfx/set-up-your-developer-tenant" SEODescription="Set up an Office 365 developer tenant so that you can test and debug your SharePoint client-side web parts" />
6+
<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" />
77
<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" />
88
<Item text="SharePoint Framework Toolchain" url="spfx/sharepoint-framework-toolchain" SEODescription="The SharePoint Framework toolchain is the set of build tools, framework packages, and other items that manage building and deploying your client side projects." />
99
<Item text="Web parts" url="spfx/web-parts" SEODescription="">

0 commit comments

Comments
 (0)