Skip to content

Commit d3632c9

Browse files
andrewconnellandrewconnell
authored
Merge pull request SharePoint#9623 from andrewconnell/contnet-update/spfx-config-tenantdomain
♻️ remove incorrect statements about `{tenantdomain}`
2 parents 892bc28 + 6ccacee commit d3632c9

File tree

7 files changed

+7
-154
lines changed

7 files changed

+7
-154
lines changed

‎docs/spfx/viva/features/focus-feature/FocusFeatureTutorial.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ When prompted, enter the following values (select the default option for all pro
2525

2626
At this point, Yeoman installs the required dependencies and scaffolds the solution files. This process might take few minutes.
2727

28-
Before moving forward, update the title and description fields of your ACE to give it a personal touch.
28+
Before moving forward, update the `title` and `description` fields of your ACE to give it a personal touch.
2929

3030
```json
3131
{
@@ -57,25 +57,7 @@ Before moving forward, update the title and description fields of your ACE to gi
5757
}
5858
```
5959

60-
## Update your project's hosted workbench URL
61-
62-
When you use the gulp task **serve**, by default it will launch a browser with the specified hosted workbench URL specified in your project. The default URL for the hosted workbench in a new project points to an invalid URL.
63-
64-
- Locate and open the file **./config/serve.json** in your project.
65-
- Locate the property `initialPage`:
66-
67-
```json
68-
{
69-
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
70-
"port": 4321,
71-
"https": true,
72-
"initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
73-
}
74-
```
75-
76-
- Change the `{tenantDomain}` ___domain to the URL of your SharePoint tenant and site you want to use for testing. For example: `https://contoso.sharepoint.com/sites/devsite/_layouts/workbench.aspx`.
77-
78-
At this point, if you do **gulp serve**, then you'll see the **FocusFeature** card:
60+
Next, run **gulp serve** from the command line in the root of the project to start the build and debugging process. In the hosted workbench, you'll see the **FocusFeature** card:
7961

8062
![See the FocusFeature card icon in the webpart toolbox](./img/focusFeatureTutorialACE.png)
8163

‎docs/spfx/viva/get-started/actions/geolocation/GeolocationTutorial.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,7 @@ When prompted, enter the following values (select the default option for all pro
3030

3131
At this point, Yeoman installs the required dependencies and scaffolds the solution files. This process might take few minutes.
3232

33-
## Update your project's hosted workbench URL
34-
35-
When you use the gulp task **serve**, by default it will launch a browser with the specified hosted workbench URL specified in your project. The default URL for the hosted workbench in a new project points to an invalid URL.
36-
37-
- Locate and open the file **./config/serve.json** in your project.
38-
- Locate the property `initialPage`:
39-
40-
```json
41-
{
42-
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
43-
"port": 4321,
44-
"https": true,
45-
"initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
46-
}
47-
```
48-
49-
- Change the `{tenantDomain}` ___domain to the URL of your SharePoint tenant and site you want to use for testing. For example: `https://contoso.sharepoint.com/sites/devsite/_layouts/workbench.aspx`.
50-
51-
At this point, if you do **gulp serve**, then you will see the **GeoLocation** card:
33+
Next, run **gulp serve** from the command line in the root of the project. When the hosted workbench loads, you'll see the **GeoLocation** card:
5234

5335
![See the GeoLocation card icon in the webpart toolbox](../../../../../../docs/images/viva-extensibility/geolocation/geoloactionAppIcon.png)
5436

‎docs/spfx/viva/get-started/actions/media-upload/MediaUploadTutorial.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,35 +25,15 @@ When prompted, enter the following values (select the default option for all pro
2525

2626
At this point, Yeoman installs the required dependencies and scaffolds the solution files. This process might take few minutes.
2727

28-
## Update your project's hosted workbench URL
29-
30-
When you use the gulp task **serve**, by default it will launch a browser with the specified hosted workbench URL specified in your project. The default URL for the hosted workbench in a new project points to an invalid URL.
31-
32-
- Locate and open the file **./config/serve.json** in your project.
33-
- Locate the property `initialPage`:
34-
35-
```json
36-
{
37-
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
38-
"port": 4321,
39-
"https": true,
40-
"initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
41-
}
42-
```
43-
44-
- Change the `{tenantDomain}` ___domain to the URL of your SharePoint tenant and site you want to use for testing. For example: `https://contoso.sharepoint.com/sites/devsite/_layouts/workbench.aspx`.
45-
46-
At this point, if you do **gulp serve**, then you'll see the **MediaUpload** card:
28+
Next, run **gulp serve** from the command line in the root of the project. When the hosted workbench loads, you'll see the **MediaUpload** card:
4729

4830
![See the MediaUpload card icon in the webpart toolbox](./img/mediaUploadTutorialACE.PNG)
4931

5032
## Add media upload action to your Adaptive Card Extension
5133

5234
At this point, we have out of the box Adaptive Card Extension code. Now it's time to flare things up with selecting media from the Card and Quick views.
5335

54-
In the Card View, we'll provide a button that will perform the following actions:
55-
56-
- Upload an image file
36+
In the Card View, we'll provide a button that will perform the following actions: **Upload an image file**
5737

5838
### Update the labels that will show up on the card
5939

‎docs/spfx/viva/get-started/build-data-visualization-adaptive-card-extension.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,7 @@ When prompted, enter the following values (select the default option for all oth
3232

3333
At this point, Yeoman installs the required dependencies and scaffolds the solution files. This process might take few minutes.
3434

35-
## Update your project's hosted workbench URL
36-
37-
When you use the gulp task **serve**, by default it will launch a browser with the specified hosted workbench URL specified in your project. The default URL for the hosted workbench in a new project points to an invalid URL.
38-
39-
- Locate and open the file **./config/serve.json** in your project.
40-
- Locate the property `initialPage`:
41-
42-
```json
43-
{
44-
"$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
45-
"port": 4321,
46-
"https": true,
47-
"initialPage": "https://{tenantDomain}/ _layouts/workbench.aspx"
48-
}
49-
```
50-
51-
- Change the `{tenantDomain}` ___domain to the URL of your SharePoint tenant and site you want to use for testing. For example: `https://contoso.sharepoint.com/sites/devsite/_layouts/workbench.aspx`.
52-
53-
At this point, if you do `gulp serve`, and select the add icon in the hosted workbench to open the toolbox, you'll see the **Data Visualization** card:
35+
Next, run **gulp serve** from the command line in the root of the project. Select the add icon in the hosted workbench to open the toolbox, you'll see the **Data Visualization** card:
5436

5537
![See the Data Visualization card icon in the workbench toolbox](../../../../docs/images/viva-extensibility/data-visualization/toolbox.png)
5638

‎docs/spfx/viva/get-started/build-first-sharepoint-adaptive-card-extension.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -30,31 +30,6 @@ When prompted, enter the following values (*select the default option for all pr
3030

3131
At this point, Yeoman installs the required dependencies and scaffolds the solution files. This process might take few minutes.
3232

33-
### Update your project's hosted workbench URL
34-
35-
When you use the gulp task **serve**, by default it will launch a browser with the specified hosted workbench URL specified in your project. The default URL for the hosted workbench in a new project points to an invalid URL.
36-
37-
- Locate and open the file **./config/serve.json** in your project.
38-
- Locate the property `initialPage`:
39-
40-
```json
41-
{
42-
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
43-
"port": 4321,
44-
"https": true,
45-
"initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
46-
}
47-
```
48-
49-
- Change the `{tenantDomain}` ___domain to the URL of your SharePoint tenant and site you want to use for testing. For example: `https://contoso.sharepoint.com/sites/devsite/_layouts/workbench.aspx`.
50-
51-
> [!TIP]
52-
> You can also start the local web server without launching a browser by including the `nobrowser` argument to the **gulp serve** command. For example, you may not want to modify the **serve.json** file in all your projects and instead, use a bookmark to launch your hosted workbench.
53-
>
54-
> ```console
55-
> gulp serve --nobrowser
56-
> ```
57-
5833
## Serve the ACE in the workbench
5934

6035
Before digging into the code, run the scaffolded output and see what an Adaptive Card Extension looks like.

‎docs/spfx/viva/get-started/build-people-search-adaptive-card-extension.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -39,25 +39,7 @@ When prompted, enter the following values (select the default option for all que
3939

4040
At this point, Yeoman installs the required dependencies and scaffolds the solution files. This process might take few minutes.
4141

42-
## Update your project's hosted workbench URL
43-
44-
When you use the gulp task **serve**, by default it opens a browser with the specified hosted workbench URL specified in your project. The default URL for the hosted workbench in a new project points to an invalid URL.
45-
46-
- Locate and open the file **./config/serve.json** in your project
47-
- Locate the property `initialPage`
48-
49-
```json
50-
{
51-
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
52-
"port": 4321,
53-
"https": true,
54-
"initialPage": "https://{tenantDomain}/ _layouts/workbench.aspx"
55-
}
56-
```
57-
58-
- Change the `{tenantDomain}` ___domain to the URL of your SharePoint tenant and site you want to use for testing. For example: `https://contoso.sharepoint.com/sites/devsite/_layouts/workbench.aspx`.
59-
60-
At this point, if you do **gulp serve**, then you see the **People Search** card:
42+
Next, run **gulp serve** from the command line in the root of the project. Once the hosted workbench loads, you'll see the **People Search** card:
6143

6244
![See the People Search card icon in the workbench toolbox](../../../../docs/images/viva-extensibility/people-search/toolbox.png)
6345

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

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -81,31 +81,6 @@ The client-side toolchain uses HTTPS endpoints by default. Part of the [Set up y
8181
>
8282
> If you didn't trust the dev cert, follow the steps outlined on this page: [Set up your development environment: Trusting the self-signed developer certificate](../../set-up-your-development-environment.md#trusting-the-self-signed-developer-certificate).
8383
84-
### Update your project's hosted workbench URL
85-
86-
When you use the gulp task **serve**, by default it will launch a browser with the specified hosted workbench URL specified in your project. The default URL for the hosted workbench in a new project points to an invalid URL.
87-
88-
- Locate and open the file **./config/serve.json** in your project.
89-
- Locate the property `initialPage`:
90-
91-
```json
92-
{
93-
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
94-
"port": 4321,
95-
"https": true,
96-
"initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
97-
}
98-
```
99-
100-
- Change the `tenantDomain` to the URL of your SharePoint tenant. For example: `https://contoso.sharepoint.com/_layouts/workbench.aspx`.
101-
102-
> [!TIP]
103-
> You can also start the local web server without launching a browser by including the `nobrowser` argument to the **gulp serve** command. For example, you may not want to modify the **serve.json** file in all your projects and instead, use a bookmark to launch your hosted workbench.
104-
>
105-
> ```console
106-
> gulp serve --nobrowser
107-
> ```
108-
10984
### Start the local web server & launch the hosted workbench
11085

11186
Assuming you've installed & trusted developer certificate, execute the following command in the console to build and preview your web part:
@@ -116,11 +91,6 @@ gulp serve
11691

11792
This command executes a series of gulp tasks to create and start a local webserver hosting the endpoints **localhost:4321** and **localhost:5432**. It will then open your default browser and load the hosted workbench preview web parts from your local dev environment.
11893

119-
> [!NOTE]
120-
> If you're seeing issues working with the hosted workbench, please see details on installing a developer certificate: [Set up your development environment: Trusting the self-signed developer certificate](../../set-up-your-development-environment.md#trusting-the-self-signed-developer-certificate).
121-
>
122-
> If you're still seeing issues, see: [SharePoint Framework known issues and frequently asked questions](../../known-issues-and-common-questions.yml)
123-
12494
```console
12595
gulp serve
12696
Build target: DEBUG

0 commit comments

Comments
 (0)