Skip to content

Commit 3c7b582

Browse files
committed
🐞 remove unnecessary specifics from doc
- doc referenced a specific Node version range... we don't need this level of detail in the docs as it makes it cumbersome to maintain, instead, just refer to the Node version and let the reader refer to the Node site/docs for the actual LTS version range for the major version we reference - fixed numerous typos, gramatical, & formatting issues - fixes SharePoint#9023
1 parent 1609e86 commit 3c7b582

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

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

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Set up your SharePoint Framework development environment
33
description: Use any text editor to build SharePoint Framework solutions. You can use macOS, Windows, or Linux.
4-
ms.date: 06/05/2023
4+
ms.date: 06/22/2023
55
ms.localizationpriority: high
66
ms.custom: scenarios:getting-started
77
---
@@ -12,7 +12,7 @@ You can use any text editor to build SharePoint Framework (SPFx) solutions. You
1212
> [!NOTE]
1313
> Before following the steps in this article, be sure to [Set up your Microsoft 365 tenant](./set-up-your-developer-tenant.md).
1414
15-
You can also follow these steps by watching this video on the Microsoft 365 Platform Communtiy (PnP) YouTube Channel:
15+
You can also follow these steps by watching this video on the Microsoft 365 Platform Community (PnP) YouTube Channel:
1616

1717
> [!Video https://www.youtube.com/embed/Cxx9MdjEiEw]
1818
@@ -42,9 +42,9 @@ You can check if you already have Node.js already installed, including installed
4242
node --version
4343
```
4444

45-
The SharePoint Framework v1.17.3 is supported on the following Node.js versions:
45+
The SharePoint Framework v1.17.* is supported on the following Node.js versions:
4646

47-
- Node.js v16 LTS (v16.13.x - v16.18.x, *aka: Gallium*)
47+
- Node.js v16 LTS (*aka: Gallium*)
4848

4949
> [!CAUTION]
5050
> If you're building SharePoint Framework components for SharePoint on-prem deployments, refer to the additional pages listed in the [See also](#see-also) section for more information.
@@ -110,7 +110,7 @@ You should be using a modern web browser like [Microsoft Edge](https://www.micro
110110

111111
## Trusting the self-signed developer certificate
112112

113-
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.
113+
The SharePoint Framework's local web server, 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.
114114

115115
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)](web-parts/get-started/build-a-hello-world-web-part.md) tutorial.
116116

@@ -125,13 +125,13 @@ gulp trust-dev-cert
125125
126126
## Optional tools
127127

128-
Following are some tools that might come in handy as well:
128+
While not required for SPFx development, you may also find the following tools useful:
129129

130130
- [Fiddler](https://www.telerik.com/fiddler)
131131
- [Postman](https://www.getpostman.com/docs/postman/launching_postman/navigating_postman)
132132
- [Windows Terminal](https://github.com/Microsoft/Terminal)
133133
- [Cmder for Windows](https://cmder.app/)
134-
- [Oh My Zsh for macOS](http://ohmyz.sh/)
134+
- [Oh My Zsh](http://ohmyz.sh/)
135135
- [Git source control tools](https://git-scm.com/)
136136

137137
## Next steps
@@ -140,14 +140,15 @@ You're now ready to [build your first client-side web part](web-parts/get-starte
140140

141141
## SPFx & SharePoint Server (on-prem)
142142

143-
The SPFx is available on SharePoint Online (SPO), SharePoint Server 2019, & SharePoint Server 2016. The configuration instructions on this page assume you're creating solutions using the latest version of the SPFx for SharePoint Online.
143+
The SPFx is available on SharePoint Online (SPO), SharePoint Server Subscription Edition (SE), SharePoint Server 2019, & SharePoint Server 2016. The configuration instructions on this page assume you're creating solutions using the latest version of the SPFx for SharePoint Online.
144144

145145
SharePoint Online contains all versions of the SPFx, including all previous and the latest version. Each SPFx solution contains information to tell SPO which SPFx runtime it depends.
146146

147147
If you're building solutions for a SharePoint Server on-prem deployment, review to the [See also](#see-also) section for details on specific SharePoint versions. Each SharePoint on-prem only supports a specific version of SPFx. This can introduce complicated development environment configurations if you're creating different solutions for different SharePoint deployments.
148148

149-
- **SharePoint Server 2016 uses the SharePoint Framework (SPFx) v1.1.**
150-
- **SharePoint Server 2019 uses the SharePoint Framework (SPFx) v1.4.1.**
149+
- **SharePoint Server 2016 uses the SharePoint Framework (SPFx) v1.1.0.** *For more information, see [SharePoint Framework development with SharePoint Server 2016 Feature Pack 2](sharepoint-2016-support.md).*
150+
- **SharePoint Server 2019 uses the SharePoint Framework (SPFx) v1.4.1.** *For more information, see [SharePoint Framework development with SharePoint Server 2019 and Subscription Edition](sharepoint-2019-and-subscription-edition-support.md).*
151+
- **SharePoint Server Subscription Edition uses the SharePoint Framework (SPFx) v1.5.1.** *For more information, see [SharePoint Framework development with SharePoint Server 2019 and Subscription Edition](sharepoint-2019-and-subscription-edition-support.md).*
151152

152153
Depending on your scenario, you may need to maintain different development environments. Developers have used the following approaches to address these challenges:
153154

@@ -157,6 +158,7 @@ Depending on your scenario, you may need to maintain different development envir
157158

158159
> [!TIP]
159160
> For more information on NVM, see [Better Node.js Install Management with Node Version Manager](https://www.voitanos.io/blog/better-node-js-install-management-with-node-version-manager/).
161+
>
160162
> - [NVM](https://github.com/creationix/nvm) for macOS
161163
> - [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows
162164
@@ -182,7 +184,7 @@ In case the certificate is not added to the Trusted Root Certification Authority
182184

183185
### Unable to Install Packages with NPM - Corporate Proxies
184186

185-
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: [Configure NPM for a coporate web proxy](https://www.voitanos.io/blog/node-npm-fix-proxy-config/)
187+
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: [Configure NPM for a corporate web proxy](https://www.voitanos.io/blog/node-npm-fix-proxy-config/)
186188

187189
## See also
188190

0 commit comments

Comments
 (0)