Skip to content

Commit 10fdf79

Browse files
committed
address Acrolinx issues
1 parent 2fb641a commit 10fdf79

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

articles/communication-services/quickstarts/rooms/get-started-rooms.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ This quickstart helps you get started with Azure Communication Services Rooms. A
1919

2020
## Object model
2121

22-
The table below lists the main properties of `room` objects:
22+
The following table lists the main properties of `room` objects:
2323

2424
| Name | Description |
2525
|-----------------------|-------------------------------------------|
2626
| `roomId` | Unique `room` identifier. |
2727
| `validFrom` | Earliest time a `room` can be used. |
2828
| `validUntil` | Latest time a `room` can be used. |
29-
| `pstnDialOutEnabled`* | Enable or disable dialing out to a PSTN number in a room.|
29+
| `pstnDialOutEnabled` | Enable or disable dialing out to a PSTN number in a room.|
3030
| `participants` | List of participants to a `room`. Specified as a `CommunicationIdentifier`. |
3131
| `roleType` | The role of a room participant. Can be either `Presenter`, `Attendee`, or `Consumer`. |
3232

@@ -61,7 +61,7 @@ This quickstart helps you get started with Azure Communication Services Rooms. A
6161

6262
## Next steps
6363

64-
Once you've created the room and configured it, you can learn how to [join a rooms call](join-rooms-call.md).
64+
You can learn how to [join a rooms call](join-rooms-call.md) ater creating and configuring the room.
6565

6666
In this section you learned how to:
6767
> [!div class="checklist"]

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-az-cli.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ az extension add --name communication
2929
```
3030

3131
### Sign in to Azure CLI
32-
You'll need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in running the ```az login``` command from the terminal and providing your credentials.
32+
You need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in running the ```az login``` command from the terminal and providing your credentials.
3333

3434

3535
### Store your connection string in an environment variable
@@ -42,7 +42,7 @@ You can configure the `AZURE_COMMUNICATION_CONNECTION_STRING` environment variab
4242
setx AZURE_COMMUNICATION_CONNECTION_STRING "<connectionString>"
4343
```
4444

45-
After you add the environment variable, you may need to restart any running programs that will need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example.
45+
After you add the environment variable, you might need to restart any running programs that need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example.
4646

4747
##### [macOS](#tab/unix)
4848

@@ -52,7 +52,7 @@ Edit your **`.zshrc`**, and add the environment variable:
5252
export AZURE_COMMUNICATION_CONNECTION_STRING="<connectionString>"
5353
```
5454

55-
After you add the environment variable, run `source ~/.zshrc` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable.
55+
After you add the environment variable, run `source ~/.zshrc` from your console window to make the changes effective. If you created the environment variable with your IDE open, you might need to close and reopen the editor, IDE, or shell in order to access the variable.
5656

5757
##### [Linux](#tab/linux)
5858

@@ -62,7 +62,7 @@ Edit your **`.bash_profile`**, and add the environment variable:
6262
export AZURE_COMMUNICATION_CONNECTION_STRING="<connectionString>"
6363
```
6464

65-
After you add the environment variable, run `source ~/.bash_profile` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable.
65+
After you add the environment variable, run `source ~/.bash_profile` from your console window to make the changes effective. If you created the environment variable with your IDE open, you might need to close and reopen the editor, IDE, or shell in order to access the variable.
6666

6767
---
6868

@@ -76,11 +76,11 @@ Use the `rooms create` command to create a room.
7676
az communication rooms create --presenter-participants "<participantId>" --consumer-participants "<participantId>" --attendee-participant "<participantId>" --valid-from "<valid-from>" --valid-until "<valid-until>" --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"
7777
```
7878

79-
- Use `<participantId>` optionally to specify the type of participant as presenter-participants, consumer-participants, or attendee-participants. If you do not specify a value, the default is empty.
79+
- Use `<participantId>` optionally to specify the type of participant as presenter-participants, consumer-participants, or attendee-participants. If you don't specify a value, the default is empty.
8080
- Replace `<connection-string>` with your Azure Communication Services connection string.
8181
- Use `<valid-from>` optionally to specify the timestamp when the room is open for joining, in ISO8601 format, ex: 2022-07-14T10:21.
8282
- Use `<valid-until>` optionally to specify the timestamp when the room can no longer be joined, in ISO8601 format, ex: 2022-07-14T10:21.
83-
- Use `<pstn-dial-out-enabled>`* optionally by setting this flag ("True" or "False") to enable or disable PSTN dial out for a room. By default, this flag is set to "False" when creating a room.
83+
- Use `<pstn-dial-out-enabled>` optionally by setting this flag ("True" or "False") to enable or disable PSTN dial out for a room. By default, this flag is set to "False" when creating a room.
8484

8585
If you've stored the connection string in environment variables as stated above, you won't need to pass them to the command.
8686

@@ -89,7 +89,7 @@ az communication rooms create
8989
```
9090

9191
### Enable PSTN Dial Out Capability for a Room
92-
The PSTN dial out can be enabled during `rooms create` by defining the `--pstn-dial-out-enabled` parameter as "True". This capability may also be modified during `rooms update` by specifying the `--pstn-dial-out-enabled` parameter.
92+
The PSTN dial out can be enabled during `rooms create` by defining the `--pstn-dial-out-enabled` parameter as "True". This capability can also be modified during `rooms update` by specifying the `--pstn-dial-out-enabled` parameter.
9393

9494
```azurecli-interactive
9595
az communication rooms create --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --connection-string "<connection-string>"
@@ -99,7 +99,7 @@ az communication rooms create --pstn-dial-out-enabled "<pstn-dial-out-enabled>"
9999
az communication rooms update --pstn-dial-out-enabled "<pstn-dial-out-enabled>" --room "<roomId>"
100100
```
101101

102-
- Use `<pstn-dial-out-enabled>` set this flag ("True" or "False") to enable or disable PSTN dial out for a room.
102+
- To enable or disable PSTN dial out for a room, set `<pstn-dial-out-enabled>` flag ("True" or "False").
103103

104104
### Get the rooms
105105

@@ -142,13 +142,13 @@ Use the `identity user create` command to create a new participant, identified b
142142
az communication identity user create
143143
```
144144

145-
Add a user as a participant to the room
145+
Add a user as a participant to the room.
146146

147147
```azurecli-interactive
148148
az communication rooms participant add-or-update --attendee-participant "<participantId>" --room "<roomId>"
149149
```
150150

151-
- Replace `<participantId>` with your participant ID. If the `<participantId>` does not exist in the room, the participant will be added to the room as an attendee role. Otherwise, the participant's role is updated to an attendee role.
151+
- Replace `<participantId>` with your participant ID. If the `<participantId>` doesn't exist in the room, the participant will be added to the room as an attendee role. Otherwise, the participant's role is updated to an attendee role.
152152
- Replace `<roomId>` with your room ID.
153153

154154
### Get list of participants in a room

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-java.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ You can review and download the sample code for this quick start on [GitHub](htt
2727

2828
### Create a new Java application
2929

30-
In a console window (such as cmd, PowerShell, or Bash), use the `mvn` command below to create a new console app with the name `rooms-quickstart`. This command creates a simple "Hello World" Java project with a single source file: **App.java**.
30+
In a console window (such as cmd, PowerShell, or Bash), use the `mvn` command to create a new console app with the name `rooms-quickstart`. This command creates a simple "Hello World" Java project with a single source file: **App.java**.
3131

3232
```console
3333
mvn archetype:generate -DgroupId=com.communication.quickstart -DartifactId=communication-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false
3434
```
3535

3636
### Include the package
3737

38-
You'll need to use the Azure Communication Rooms client library for Java [version 1.0.0](https://search.maven.org/artifact/com.azure/azure-communication-rooms/1.0.0/jar) or above.
38+
You need to use the Azure Communication Rooms client library for Java [version 1.0.0](https://search.maven.org/artifact/com.azure/azure-communication-rooms/1.0.0/jar) or above.
3939

4040
#### Include the BOM file
4141

@@ -123,7 +123,7 @@ RoomsClient roomsClient = new RoomsClientBuilder().connectionString(connectionSt
123123
## Create a room
124124

125125
### Set up room participants
126-
In order to set up who can join a room, you'll need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-java) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
126+
In order to set up who can join a room, you need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-java) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
127127

128128
To use `CommunicationIdentityClient`, add the following package:
129129

@@ -358,7 +358,7 @@ mvn package
358358

359359
```
360360

361-
Execute the app
361+
Execute the app.
362362

363363
```console
364364
mvn exec:java -D"exec.mainClass"="com.communication.rooms.quickstart" -D"exec.cleanupDaemonThreads"="false"

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-javascript.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Create a new file `index.js` where the code for this quickstart will be added.
4242

4343
### Install the packages
4444

45-
You'll need to use the Azure Communication Rooms client library for JavaScript [version 1.0.0](https://www.npmjs.com/package/@azure/communication-rooms) or above.
45+
You need to use the Azure Communication Rooms client library for JavaScript [version 1.0.0](https://www.npmjs.com/package/@azure/communication-rooms) or above.
4646

4747
Use the `npm install` command to install the below Communication Services SDKs for JavaScript.
4848

@@ -52,7 +52,7 @@ npm install @azure/communication-rooms --save
5252

5353
### Set up the app framework
5454

55-
In the `index.js` file add the following code. We will be adding the code for the quickstart in the `main` function.
55+
In the `index.js` file, add the following code. We'll be adding the code for the quickstart in the `main` function.
5656

5757
``` javascript
5858
const { RoomsClient } = require('@azure/communication-rooms');
@@ -89,7 +89,7 @@ const roomsClient = new RoomsClient(connectionString);
8989

9090
### Set up room participants
9191

92-
In order to set up who can join a room, you'll need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-javascript) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
92+
In order to set up who can join a room, you need to have the list of the identities of those users. You can follow the instructions [here](../../identity/access-tokens.md?pivots=programming-language-javascript) for creating users and issuing access tokens. Alternatively, if you want to create the users on demand, you can create them using the `CommunicationIdentityClient`.
9393

9494
To use the CommunicationIdentityClient, install the following npm package:
9595

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ cd acs-rooms-quickstart
3636

3737
### Install the package
3838

39-
You'll need to use the Azure Communication Rooms client library for Python [version 1.0.0](https://pypi.org/project/azure-communication-rooms/) or above.
39+
You need to use the Azure Communication Rooms client library for Python [version 1.0.0](https://pypi.org/project/azure-communication-rooms/) or above.
4040

4141
From a console prompt, navigate to the directory containing the rooms.py file, then execute the following command:
4242

0 commit comments

Comments
 (0)