Skip to content

Commit a91120a

Browse files
authored
Merge pull request #293 from chakkaradeep/staging
Updated docs to recent updates
2 parents 7da90d1 + 02fbfb1 commit a91120a

10 files changed

+27
-234
lines changed

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,18 @@ Choose **OK** to create the site collection.
5656

5757
SharePoint will create the developer site and you will be able to see its progress in the SharePoint admin center. After the site is created, you can browse to your developer site collection.
5858

59-
## Put the SharePoint Workbench in the document library
60-
You need the SharePoint Workbench on your developer site to test your web parts on SharePoint. SharePoint workbench is a developer design surface that enables you to quickly preview and test web parts without deploying them in SharePoint. This procedure uses the default document library in your site collection. This will be called **Documents** in the left navigation.
59+
## SharePoint Workbench
60+
SharePoint Workbench is a developer design surface that enables you to quickly preview and test web parts without deploying them in SharePoint. SharePoint Framework developer toolchain contains a version of the Workbench that works locally and helps you quickly test and validate solutions you are building. It is also hosted in your tenancy to preview and test your local web parts in development. You can access the SharePoint Workbench from any SharePoint site in your tenancy by browsing to the following URL:
6161

62-
* Download the [workbench.aspx](https://raw.githubusercontent.com/SharePoint/sp-dev-docs/master/workbench.aspx) file to your local computer. To do this:
63-
- Save opened workbench.aspx to your computer. Typically you'd do this by right clicking the page and chosing *"Save as..."*
64-
* Upload the file to the **Documents** library in the developer site collection from your computer. To do this:
65-
- Open the **Documents** library on SharePoint.
66-
- Drag and drop the workbench.aspx to the **Documents** library. Or you can choose **Upload** from the **Documents** library and locate and upload the workbench.aspx file.
62+
```
63+
https://your-sharepoint-site/_layouts/workbench.aspx
64+
```
6765

6866
## Troubleshooting
6967

7068
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.
7169

72-
If you get the following exception when moving to the `workbench.aspx` page:
70+
If you get the following exception accessing the SharePoint Workbench:
7371

7472
```
7573
"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."

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ sudo npm install -g npm@3
3030
Install a code editor. You can use any code editor or IDE that supports client-side development to build your web part, such as:
3131

3232
* [Visual Studio Code](https://code.visualstudio.com/)
33-
* [Sublime](https://www.sublimetext.com/)
3433
* [Atom](https://atom.io)
3534
* [Webstorm](https://www.jetbrains.com/webstorm)
3635

@@ -46,13 +45,6 @@ Run the following command:
4645
npm install -g --production windows-build-tools
4746
```
4847

49-
#### If you are using Visual Studio
50-
If you want to use Visual Studio as your development environment, install the following required tools and updates:
51-
52-
* [Visual Studio 2015](https://go.microsoft.com/fwlink/?LinkId=691978&clcid=0x409)
53-
* [Visual Studio Update 3](https://www.visualstudio.com/en-us/news/releasenotes/vs2015-update3-vs) or later
54-
* [Node.js Tools for Visual Studio](https://aka.ms/getntvs)
55-
5648
### If you are using Ubuntu
5749

5850
You need to install compiler tools using the following command:

docs/spfx/tools-and-libraries.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ Form more information about webpack, see the following:
6868
* [TypeScript, React, and Webpack](https://www.typescriptlang.org/docs/handbook/react-&-webpack.html)
6969

7070
## Yeoman generators
71-
[Yeoman](http://yeoman.io/) helps you to kickstart new projects, prescribing best practices and tools to help you stay productive.
72-
SharePoint Yeoman generator will be available as part of the framework to kickstart new client-side web part projects. Once the project is generator, you can use your choice of IDEs like [Visual Studio](https://www.visualstudio.com/products/visual-studio-community-vs) or HTML/JavaScript code editors like [Visual Studio Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/) or [Atom](https://atom.io/).
71+
[Yeoman](http://yeoman.io/) helps you to kickstart new projects, prescribing best practices and tools to help you stay productive. SharePoint Yeoman generator will be available as part of the framework to kickstart new client-side web part projects.
7372

7473
For more information about Yeoman, see the following:
7574

@@ -81,6 +80,15 @@ The following are some common Yeoman generators that you can try, depending on y
8180
* [generator-react-webpack](https://github.com/newtriks/generator-react-webpack)
8281
* [generator-angular](https://www.npmjs.com/package/generator-angular)
8382

83+
## Source code editors
84+
SharePoint Framework is client-side driven and thus you can use your choice of HTML/JavaScript code editors, such as:
85+
86+
* [Visual Studio Code](https://code.visualstudio.com/)
87+
* [Atom](https://atom.io)
88+
* [Webstorm](https://www.jetbrains.com/webstorm)
89+
90+
SharePoint Framework documentation uses Visual Studio code in the docs and examples. Visual Studio Code is a lightweight but powerful source code editor from Microsoft which runs on your desktop and is available for Windows, Mac and Linux. It comes with built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages (such as C++, C#, Python, PHP) and runtimes.
91+
8492
## SharePoint REST APIs
8593

8694
The SharePoint Framework provides key integrations with SharePoint experiences and targets web development. The SharePoint REST APIs enable you to interact with SharePoint and other workloads that shape your web part functionality.

docs/spfx/web-parts/basics/known-issues.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

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

Lines changed: 0 additions & 140 deletions
This file was deleted.

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,13 @@ When the scaffold is complete, you should see the following message indicating a
5959
For information about troubleshooting any errors, see [Known issues](../basics/known-issues).
6060

6161
### Using your favorite Code Editor
62-
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:
62+
Because the SharePoint client-side solution is HTML/TypeScript based, you can use any code editor that supports client-side development to build your web part, such as:
6363

6464
* [Visual Studio Code](https://code.visualstudio.com/)
65-
* [Sublime](https://www.sublimetext.com/)
6665
* [Atom](https://atom.io)
6766
* [Webstorm](https://www.jetbrains.com/webstorm)
6867

69-
>**Note:** This article uses Visual Studio code in the steps and examples. You can use any code editor that you prefer.
68+
SharePoint Framework documentation uses Visual Studio code in the steps and examples. Visual Studio Code is a lightweight but powerful source code editor from Microsoft which runs on your desktop and is available for Windows, Mac and Linux. It comes with built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages (such as C++, C#, Python, PHP) and runtimes..
7069

7170
## Preview the web part
7271
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.
@@ -354,7 +353,7 @@ The **HelloWorldWebPart.manifest.json** file defines the web part metadata such
354353

355354
SharePoint Workbench is also hosted in SharePoint to preview and test your local web parts in development. The key advantage is that now you are running in SharePoint context and that you will be able to interact with SharePoint data.
356355

357-
Go to the following URL: 'https://your-sharepoint-site/Shared%20Documents/workbench.aspx'
356+
Go to the following URL: 'https://your-sharepoint-site/_layouts/workbench.aspx'
358357

359358
>**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.
360359

0 commit comments

Comments
 (0)