Skip to content

Commit 300de17

Browse files
andrewconnellVesaJuvonen
authored andcommitted
Fixing multiple documentation issues (SharePoint#3227)
* update typo to match UX Closes SharePoint#3215 * update doc to match screenshot Fixes SharePoint#3212 * update link to o365 CLI Fixes SharePoint#3204 * update link targe to working link - previous link pointed to a blog post no longer published - updated to point to same topic, but as a doc from Office.com Fixes SharePoint#3203 * update broken link Fixes SharePoint#3202 * fix broken link - changed link from pointing to a blog post no longer published to official docs on same topic Fixes SharePoint#3201 * update dev env install instructions - created a troubleshooting section for common issues - removed note about SP2016 in the main part of the docs to relocate down in troubleshooting section Fixes SharePoint#2433, SharePoint#2401 * update link to O365 POSH - previous link pointed to the MSI downloads for 32 & 64 bit, but latter was a broken link - updated doc to point to the page that explains how to connect to O365 via POSH Fixes SharePoint#3171 * update odata docs to etags - previous link moved & was no longer valid Fixes SharePoint#3188
1 parent 7eeb4fe commit 300de17

9 files changed

+42
-13
lines changed

docs/declarative-customization/site-theming/sharepoint-site-theming-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following image shows how the default themes are presented in the theme pick
5252

5353
When you choose a theme in the list, those color settings are instantly applied to the page so that you can see what the selected theme will look like.
5454

55-
After you've found a theme that you want to use, choose **Save** to save your selection, or choose **Cancel** to revert to your current theme.
55+
After you've found a theme that you want to use, choose **Apply** to save your selection, or choose **Cancel** to revert to your current theme.
5656

5757
## Work with classic themes
5858

docs/solution-guidance/Branding-and-site-provisioning-solutions-for-SharePoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following table lists terms and concepts that are useful to know as you star
4141
|Term or concept|Description|For more information|
4242
|:-----|:-----|:-----|
4343
|App web|The website from which an add-in is deployed.| [Host webs, add-in webs, and SharePoint components in SharePoint](../sp-add-ins/host-webs-add-in-webs-and-sharepoint-components-in-sharepoint.md)|
44-
|Approval workflow|Workflows specific to publishing sites that specifies who approves the publication of a page and when.|- [SharePoint 2013 approval workflow](https://blogs.msdn.microsoft.com/thirusrinivasan1/2013/10/31/sharepoint-2013-workflow-calling-a-wcf-service/)<br/>- [Get started with workflows in SharePoint 2013](../general-development/get-started-with-workflows-in-sharepoint.md)|
44+
|Approval workflow|Workflows specific to publishing sites that specifies who approves the publication of a page and when.|- [Work with a publishing approval workflow](https://support.office.com/en-us/article/work-with-a-publishing-approval-workflow-e99aad65-e453-4bdb-9c2f-f27c6733ddae)<br/>- [Get started with workflows in SharePoint 2013](../general-development/get-started-with-workflows-in-sharepoint.md)|
4545
|ClientContext|A central object that serves as a "center of gravity" for all SharePoint CSOM and JSOM operations.| [T:Microsoft.SharePoint.Client.ClientContext](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.clientcontext.aspx)|
4646
|Cloud Add-in Model |SharePoint Add-ins are self-contained pieces of functionality that extend the capabilities of a SharePoint website. You can use the Cloud Add-in Model to author and deliver secure, reliable, flexible, and consistent SharePoint Add-ins.| [Overview of SharePoint Add-ins](../sp-add-ins/sharepoint-add-ins.md)|
4747
|Content database|Content databases store all content for a site collection, including the following:<br/>- Site documents and files in document libraries<br/>- List data<br/>- Web part properties<br/>- User names and rights | [Database types and descriptions in SharePoint Server](https://docs.microsoft.com/en-us/SharePoint/technical-reference/database-types-and-descriptions)|

docs/solution-guidance/feature-stapling-sharepoint-add-in.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ When you are migrating legacy code in an on-premises SharePoint environment and
4646

4747
The following article describes how to staple features to a site definition.
4848

49-
- [Feature Stapling In SharePoint 2010 (MSDN Blog Article)](http://blogs.msdn.com/b/kunal_mukherjee/archive/2011/01/11/feature-stapling-in-sharepoint-2010.aspx)
49+
- [Feature Stapling in the SharePoint Add-in model](https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/feature-stapling-sharepoint-add-in)
5050

5151
Staple Add-ins
5252
--------------

docs/solution-guidance/mms-manipulation-sharepoint-add-in.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The following sample demonstrates how to build a synchronization tool for MMS da
7575

7676
Related links
7777
=============
78-
- [Synchronize term sets using CSOM (MSDN Blog Article Documentation)](http://blogs.msdn.com/b/frank_marasco/archive/2014/06/29/synchronize-term-sets-with-the-term-store-csom.aspx)
78+
- [SharePoint 2013: Synchronize term sets with the term store (CSOM)](https://code.msdn.microsoft.com/office/SharePoint-2013-Synchronize-d40638d1)
7979
- Guidance articles at [http://aka.ms/OfficeDevPnPGuidance](http://aka.ms/OfficeDevPnPGuidance "Guidance Articles")
8080
- References in MSDN at [http://aka.ms/OfficeDevPnPMSDN](http://aka.ms/OfficeDevPnPMSDN "References in MSDN")
8181
- Videos at [http://aka.ms/OfficeDevPnPVideos](http://aka.ms/OfficeDevPnPVideos "Videos")

docs/solution-guidance/modern-experience-customizations-provisioning-sites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ $web.WebTemplate + "#" + $web.Configuration
131131

132132
### Provision a "modern" team site using the Office 365 CLI
133133

134-
Alternatively, the [Office 365 CLI](https://sharepoint.github.io/office365-cli/?utm_source=msft_docs&utm_medium=page&utm_campaign=Provisioning+modern+team+sites+programmatically) can be used to create "modern" sites. The Office 365 CLI is a cross-platform command line interface that can be used on any platform, including Windows, MacOS and Linux.
134+
Alternatively, the [Office 365 CLI](https://pnp.github.io/office365-cli/) can be used to create "modern" sites. The Office 365 CLI is a cross-platform command line interface that can be used on any platform, including Windows, MacOS and Linux.\
135135

136136
The following bash script will create a "modern" team site and then return the actual SharePoint site URL for further manipulation. Once you have access to the URL of the created site, you can use it to automate other operations on the created site.
137137

docs/solution-guidance/security-apponly-azuread.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ if(CreateSelfSignedCertificate)
160160

161161
You will be asked to give a password to encrypt your private key, and both the .PFX file and .CER file will be exported to the current folder.
162162

163-
Next step is registering an Azure AD application in the Azure Active Directory tenant that is linked to your Office 365 tenant. To do that, open the Office 365 Admin Center (https://portal.office.com) using the account of a user member of the Tenant Global Admins group. Click on the "Azure AD" link that is available under the "Admin centers" group in the left-side treeview of the Office 365 Admin Center. In the new browser's tab that will be opened you will find the [Microsoft Azure portal](https://ms.portal.azure.com). If it is the first time that you access the Azure portal with your account, you will have to register a new Azure subscription, providing some information and a credit card for any payment need. But don't worry, in order to play with Azure AD and to register an Office 365 Application you will not pay anything. In fact, those are free capabilities. Once having access to the Azure portal, select the "Active Directory" section and choose the option "App Registrations". See the next figure for further details.
163+
Next step is registering an Azure AD application in the Azure Active Directory tenant that is linked to your Office 365 tenant. To do that, open the Office 365 Admin Center (https://portal.office.com) using the account of a user member of the Tenant Global Admins group. Click on the "Azure Active Directory" link that is available under the "Admin centers" group in the left-side treeview of the Office 365 Admin Center. In the new browser's tab that will be opened you will find the [Microsoft Azure portal](https://ms.portal.azure.com). If it is the first time that you access the Azure portal with your account, you will have to register a new Azure subscription, providing some information and a credit card for any payment need. But don't worry, in order to play with Azure AD and to register an Office 365 Application you will not pay anything. In fact, those are free capabilities. Once having access to the Azure portal, select the "Active Directory" section and choose the option "App Registrations". See the next figure for further details.
164164

165165
![shows azure ad portal](media/apponly/azureadapponly1.png)
166166

docs/sp-add-ins/replace-an-expiring-client-secret-in-a-sharepoint-add-in.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Ensure the following before you begin:
1919

2020
- [Microsoft Online Services Sign-In Assistant](https://www.microsoft.com/en-us/download/details.aspx?id=39267) is installed on the development computer.
2121

22-
- Microsoft Online Services PowerShell Module ([32-bit](http://go.microsoft.com/fwlink/p/?linkid=236298); [64-bit](http://connect.microsoft.com/site1164/Downloads/DownloadDetails.aspx?DownloadID=59185)) is installed on the development computer.
22+
- You can connect to Office 365 with PowerShell: [Connect to Office 365 PowerShell](https://docs.microsoft.com/en-us/office365/enterprise/powershell/connect-to-office-365-powershell)
2323

2424
- You are a tenant administrator for the Office 365 tenant (or a farm administrator on the farm) where the add-in was registered with the AppRegNew.aspx page.
2525

docs/sp-add-ins/working-with-lists-and-list-items-with-rest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ headers:
633633

634634
## Using ETag values to determine document and list item versioning
635635

636-
The SharePoint REST service, which follows the [OData standard](http://www.odata.org/developers/protocols/operations), uses [HTML ETags for concurrency control](http://www.odata.org/developers/protocols/operations#ConcurrencycontrolandETags) of SharePoint lists and list items. To check on an item's version when you perform a **PUT**, **MERGE**, or **DELETE** request, specify an **ETag** in the **If-Match** HTTP request header.
636+
The SharePoint REST service, which follows the [OData standard](http://www.odata.org/developers/protocols/operations), uses [Header ETags](http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_HeaderETag) of SharePoint lists and list items. To check on an item's version when you perform a **PUT**, **MERGE**, or **DELETE** request, specify an **ETag** in the **If-Match** HTTP request header.
637637

638638
If the **ETag** you specify in your request does not match the **ETag** of the document or list item on the server, the REST service returns a 412 exception, per the OData specification.
639639

@@ -653,7 +653,7 @@ Within SharePoint, ETags apply only to SharePoint lists and list items.
653653
- [Work with external data in SharePoint](work-with-external-data-in-sharepoint.md)
654654
- [REST API reference and samples](https://msdn.microsoft.com/library)
655655
- [OData resources](get-to-know-the-sharepoint-rest-service.md#odata-resources)
656-
- [Develop SharePoint Add-ins](develop-sharepoint-add-ins.md)
656+
- [Develop SharePoint Add-ins](develop-sharepoint-add-ins.md)
657657

658658

659659

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

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,9 @@ Install [NodeJS LTS version 8](https://nodejs.org/dist/latest-v8.x/).
3131
- If you have NodeJS already installed, check that you have the latest version by using `node -v`. It should return the current [LTS version](https://nodejs.org/dist/latest-v8.x/).
3232
- If you are using a Mac, we recommend that you use [homebrew](http://brew.sh/) to install and manage NodeJS.
3333

34-
> [!NOTE]
34+
> [!NOTE]
3535
> NodeJS has two LTS versions - 8 and 10. The current supported LTS version of NodeJS for the SharePoint Framework is 8.x and can be downloaded from https://nodejs.org/en/download/releases/. Notice that 9.x or 10.x versions are currently not supported with SharePoint Framework development.
3636
37-
> [!NOTE]
38-
> I case you develop web parts for on-premises environments especially for SharePoint 2016 make sure you define the enviromental variable NODE_NO_HTTP2 = 1 otherwise the local workbench might not load.
39-
4037
### Install a code editor
4138

4239
You can use any code editor or IDE that supports client-side development to build your web part, such as:
@@ -91,6 +88,20 @@ npm install @microsoft/generator-sharepoint --save-dev
9188

9289
For more information about the Yeoman SharePoint generator, see [Scaffold projects by using Yeoman SharePoint generator](toolchain/scaffolding-projects-using-yeoman-sharepoint-generator.md).
9390

91+
## Trusting the self-signed developer certificate
92+
93+
The SharePoint Framework's local webserver, used when testing your custom solutions from your development environment, uses HTTPS by default. This is implemented using a development self-signed SSL certificate. Self-signed SSL certificates are not trusted by your developer environment. You must first configure your development environment to trust the certificate.
94+
95+
A utility task is included in every SharePoint Framework project in the form of a gulp task. You can elect to do this now, or wait until you create your first project as covered in the [Build your first SharePoint client-side web part (Hello World part 1): Preview the web part](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part) tutorial.
96+
97+
Once a project has been created with the Yeoman generator for the SharePoint Framework, execute the following command from within the root folder of the project.
98+
99+
```sh
100+
gulp trust-dev-cert
101+
```
102+
103+
> [!NOTE]
104+
> This assumes you have installed all dependencies with `npm install` after creating the project. This step will install all gulp tasks as part of a project.
94105
95106
## Optional tools
96107

@@ -106,5 +117,23 @@ Following are some tools that might come in handy as well:
106117

107118
You are now ready to [build your first client-side web part](web-parts/get-started/build-a-hello-world-web-part.md)!
108119

120+
## Troubleshooting
121+
122+
### SPFx Development for SharePoint Server 2016
123+
124+
SharePoint Server 2016 uses the SharePoint Framework (SPFx) v1.1. Around this the time of the v1.1 release, NodeJS was transitioning from NodeJS v6.x to v8.x. In this update, NodeJS introduced a change where the default changed from HTTP1 to HTTP2. For some, this caused issues with SPFx. A later version of SPFx resolved these issues, but those who are still working with SPFx v1.1 (such as those working with SharePoint Server 2016) may run into issues.
125+
126+
To resolve this, set the following environment variable to instruct NodeJS to use HTTP1 instead of the default HTTP2: `NODE_NO_HTTP2=1`.
127+
128+
For more information, refer to [issue #1002](https://github.com/SharePoint/sp-dev-docs/issues/1002).
129+
130+
### Unable to Trust the Self-signed Development Certificate
131+
132+
In some cases, executing the command `gulp trust-dev-cert`, does not have the desired effect of trusting the self-signed development certificate on your machine. In rare cases such as these, you may need to delete a hidden folder that's generated in your profile folder. Locate & delete the folder `<homedir>/.gcb-serve-data` and then try to trust the self-signed development certificate again.
133+
134+
### Unable to Install Packages with NPM - Corporate Proxies
135+
136+
If your development environment is behind a corporate proxy, you need to configure NPM to use that proxy. Refer to the [npm-config](https://docs.npmjs.com/misc/config) documents on how to configure your development environment behind a corporate proxy... specifically the **proxy** & **http-proxy** settings. More information: [How to setup Node.js and Npm behind a corporate web proxy](https://jjasonclark.com/how-to-setup-node-behind-web-proxy/)
137+
109138
> [!NOTE]
110139
> If you find an issue in the documentation or in the SharePoint Framework, report that to SharePoint engineering by using the [issue list at sp-dev-docs repository](https://github.com/SharePoint/sp-dev-docs/issues). Thanks for your input in advance.

0 commit comments

Comments
 (0)