Skip to content

Commit 9878e02

Browse files
authored
Correcting typos/adding consistency for the Administrator Guides in: cdn, data-base-migration, dashboard, general, notifications, white-labeling (RocketChat#1944)
* Typos * Typos * Typos * Typos * Typos * Update connectivity-services.md * Update connectivity-services.md * Update connectivity-services.md
1 parent a775063 commit 9878e02

File tree

9 files changed

+77
-59
lines changed

9 files changed

+77
-59
lines changed

guides/administrator-guides/cdn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ If the situation occurs where CDN stops working or the provided values are incor
4040

4141
As the front end of Rocket.Chat may be inaccessible, the backend Mongo database can be updated to remove the CDN. The following Mongo commands should reset the value to the default state.
4242

43-
```text
43+
```javascript
4444
db.rocketchat_settings.update({_id:"CDN_PREFIX"},{$set:{"value":""}})
4545
```
4646

47-
```text
47+
```javascript
4848
db.rocketchat_settings.update({_id:"CDN_JSCSS_PREFIX"},{$set:{"value":""}})
4949
```
5050

guides/administrator-guides/connectivity-services.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44

5-
Rocket.Chat Cloud provides a list of features/services such as
5+
Rocket.Chat Cloud provides a list of features/services such as:
66

77
* [Rocket.Chat Push Notification Gateway](https://docs.rocket.chat/guides/administrator-guides/notifications/push-notifications#push-gateway)
88
* [Rocket.Chat Marketplace](https://rocket.chat/marketplace)
@@ -23,19 +23,19 @@ In order to connect your server to our Cloud, your Rocket.Chat server must be at
2323

2424
**If you don't have a cloud account yet:**
2525

26-
1. Go to [cloud.rocket.chat](https://cloud.rocket.chat/) and create a new account
26+
1. Go to [cloud.rocket.chat](https://cloud.rocket.chat/) and create a new account.
2727

2828
![](../../.gitbook/assets/image%20%28154%29.png)
2929

30-
2. Fill up the registration form and "Register"
30+
2. Fill up the registration form and "Register".
3131

3232
![](../../.gitbook/assets/c_4.png)
3333

34-
3. A verification email will be sent in order to activate your new Cloud account
34+
3. A verification email will be sent in order to activate your new Cloud account.
3535

3636
![](../../.gitbook/assets/image%20%28155%29.png)
3737

38-
4. The verification link will forward to cloud.rocket.chat. After the validation, you will be logged into your Cloud console. In order to register your self-hosted workspace, please select the "Register self-managed" button
38+
4. The verification link will forward to cloud.rocket.chat. After the validation, you will be logged into your Cloud console. In order to register your self-hosted workspace, please select the "Register self-managed" button.
3939

4040
![](../../.gitbook/assets/c_6.png)
4141

@@ -44,7 +44,7 @@ In order to connect your server to our Cloud, your Rocket.Chat server must be at
4444
* Internet Access: Rocket.Chat server that has a connection to the internet \(connected to the outside\)
4545
* No Internet Access: Special cases where Rocket.Chat server has no connection at all \(totally air-gapped\).
4646

47-
In this document, we are covering only the "Internet Access" option
47+
In this document, we are covering only the "Internet Access" option.
4848

4949
6. When selecting the "Internet Access" option, a registration token will be generated. Copy the token as this will be used to register your Rocket.Chat server.
5050

@@ -63,10 +63,10 @@ Fill up the "Email" field with the email related to your Rocket.Chat Cloud accou
6363

6464
9. Finally, in order to ensure the synchronization between Rocket.Chat server and Rocket.Chat Cloud, hit the "Sync" button as this will trigger the synchronization framework.
6565

66-
This is recommended right after registering your server. The newly registered workspace will be listed in the "Workspace" section at [cloud.rocket.chat](https://cloud.rocket.chat/)
66+
This is recommended right after registering your server. The newly registered workspace will be listed in the "Workspace" section at [cloud.rocket.chat](https://cloud.rocket.chat/).
6767

6868
{% hint style="success" %}
69-
If you are an enterprise customer \(self-hosted Enterprise or Pro-licensed\), we create a cloud account for you. Please login to your workspace, insert the cloud registration code you received in the welcome email, and then hit **Login to** [**Rocket.Chat**](http://rocket.chat/) **Cloud**
69+
If you are an enterprise customer \(self-hosted Enterprise or Pro-licensed\), we create a cloud account for you. Please login to your workspace, insert the cloud registration code you received in the welcome email, and then hit **Login to** [**Rocket.Chat**](http://rocket.chat/) **Cloud**.
7070
{% endhint %}
7171

7272

guides/administrator-guides/database-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ db.migrations.update({_id: 'control'},{$set:{locked:false,version:19}})
3232

3333
Restart Rocket.Chat and the migration should succeed now to the latest version.
3434

35-
**Note**: certain new values that are vital to Rocket.Chat operations may remain unpopulated when you skip versions. For example, you may have to manually apply roles to users.
35+
**Note**: Certain new values that are vital to Rocket.Chat operations may remain unpopulated when you skip versions. For example, you may have to manually apply roles to users.
3636

guides/administrator-guides/engagement-dashboard.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ Engagement Dashboard is an enterprise-only feature.
1010

1111
To access the **Engagement Dashboard:**
1212

13-
1. Go to **Administration.**
13+
1. Go to **Administration**:
1414

1515
![](../../.gitbook/assets/image%20%2830%29.png)
1616

17-
2. Click **Engagement Dashboard**.
17+
2. Click **Engagement Dashboard**:
1818

1919
![](../../.gitbook/assets/image%20%28139%29%20%281%29%20%281%29.png)
2020

2121
As an administrator, you can see your _User_, _Messages_, and _Channels_ engagement here.
2222

2323
## User
2424

25-
The user tab shows you the following engagement matrices.
25+
The user tab shows you the following engagement matrices:
2626

2727
![](../../.gitbook/assets/image%20%28129%29%20%281%29%20%281%29%20%281%29.png)
2828

@@ -72,7 +72,7 @@ It represents the time by day or hour when your chat is busier, as shown below:
7272

7373
## Messages
7474

75-
The Messages tab shows you the following engagement matrices.
75+
The Messages tab shows you the following engagement matrices:
7676

7777
![](../../.gitbook/assets/image%20%28138%29.png)
7878

@@ -94,7 +94,7 @@ It represents the public, private, and top 5 most popular channel to which the m
9494

9595
## Channels
9696

97-
This table shows you the count of _messages being sent_ and the _increment/decrement_ of count from the last interval for a selected period for **all** your channels. You can also download this information in a CSV file.
97+
This table shows you the count of _messages being sent_ and the _increment/decrement_ of count from the last interval for a selected period for **all** your channels. You can also download this information in a CSV file:
9898

9999
![](../../.gitbook/assets/image%20%28141%29.png)
100100

guides/administrator-guides/general.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If you are integrating Bugsnag with Rocket.Chat, you should put your Bugsnag API
1212

1313
### CDN Prefix for JS/CSS
1414

15-
Insert here the prefix for the CDN that should load the JS/CSS assets
15+
Insert here the prefix for the CDN that should load the JS/CSS assets.
1616

1717
### CDN Prefix
1818

@@ -33,7 +33,7 @@ Insert here the name of the channel that the user will enter after logging in. S
3333

3434
### Force Disable OpLog for Cache
3535

36-
Will not use OpLog to sync cache even when it's available
36+
Will not use OpLog to sync cache even when it's available.
3737

3838
### Force SSL
3939

@@ -73,20 +73,20 @@ This sets the URL of the server.
7373
7474
### Store Last Message
7575

76-
Store last message sent on each room. This will enable the viewing of the last message on the left sidebar \(should be on by default\)
76+
Store last message sent on each room. This will enable the viewing of the last message on the left sidebar \(should be on by default\).
7777

7878
### Unread Count
7979

80-
This setting changes the behavior of the unread counter
80+
This setting changes the behavior of the unread counter.
8181

8282
* **All messages**: All messages will be counted on the counter, regardless if they are a mention or not.
8383
* **User mentions only**: Only mentions using `@yourUsername` will be counted on the counter.
8484
* **Group mentions only**: Only group mentions using `@all` or `@here` will be counted on the counter.
85-
* **User and group mentions only**: All mentions will be counted, this includes `@all`, `@here` and `@yourUsername`
85+
* **User and group mentions only**: All mentions will be counted, this includes `@all`, `@here` and `@yourUsername`.
8686

8787
### Unread Count for Direct Messages
8888

89-
This setting changes the behavior of the unread counter on Direct Messages
89+
This setting changes the behavior of the unread counter on Direct Messages.
9090

9191
* **All messages**: All messages sent by another user will be counted on the counter.
9292
* **Mentions only**: Only mentions using `@yourUsername` will be counted on the counter.
@@ -131,7 +131,7 @@ Max number of members in room when notifications for all messages gets disabled.
131131

132132
This setting affects the `count` query parameter. See more at [Offset and Count Information](https://developer.rocket.chat/api/rest-api/offset-and-count-and-sort-info)
133133

134-
* **Yes**: Allows the usage of the number `0` as `count` parameter. Setting `count` to `0` will return **ALL** the data from that endpoint
134+
* **Yes**: Allows the usage of the number `0` as `count` parameter. Setting `count` to `0` will return **ALL** the data from that endpoint.
135135
* **No**: Setting the number `0` on `count`, will return `0` results.
136136

137137
> Should calls to the REST API be allowed to return everything in one call?
@@ -140,7 +140,7 @@ This setting affects the `count` query parameter. See more at [Offset and Count
140140

141141
Here you can set what origins are allowed to make requests to your server.
142142

143-
> You can use `*` to accept from all origins. For multiple Origins use a comma separated list. E.g `https://domain1.com, https://domain2.com, https://domain3.com`
143+
> You can use `*` to accept from all origins. For multiple Origins use a comma separated list. E.g. `https://domain1.com, https://domain2.com, https://domain3.com`
144144
145145
### Default Count
146146

@@ -164,11 +164,11 @@ Enables the usage of [Shields](https://developer.rocket.chat/api/rest-api/method
164164
165165
### Shield Types
166166

167-
Types of shields to enable as a comma separated list, choose from `online`, `channel` or `*` for all
167+
Types of shields to enable as a comma separated list, choose from `online`, `channel` or `*` for all.
168168

169169
### Max Record Amount
170170

171-
This sets the maximum number of records the REST API should return when not set to unlimited
171+
This sets the maximum number of records the REST API should return when not set to unlimited.
172172

173173
### User Limit for Adding All Users to Channel
174174

@@ -209,7 +209,7 @@ Should be a valid JSON where keys are languages containing a dictionary of key a
209209

210210
### UTF8 Names Validation
211211

212-
RegExp that will be used to validate usernames and channel names
212+
RegExp that will be used to validate usernames and channel names.
213213

214214
> **Note**: If you are having problems with names when creating channels \(when using non-english characters for example\) changing these values will probably fix it. For example using `[\w_-]+` should allow any non-space character to be part of a name.
215215

guides/administrator-guides/notifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ Notifications of direct messages or mentions by @username are sent by Email to y
1818

1919
## Mentions
2020

21-
@username - notifies this person @all - notifies all members of this room or channel @here - notifies all members of this room or channel who are online
21+
@username - notifies this person @all - notifies all members of this room or channel @here - notifies all members of this room or channel who are online.
2222

guides/administrator-guides/white-labeling/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
When using Rocket.Chat you have a plethora of customization options, ranging from basic color switching to full css control. Here you will find all the guides you need to customize your Rocket.Chat Server.
44

5-
In these guides we will be talking about customizations without changing the source code, for that you can check our \[Developer Guides\].
5+
In these guides we will be talking about customizations without changing the source code, for that you can check our [Developer Guides](https://docs.rocket.chat/guides/developer).
66

77
We will be separating these guides into 2 categories: basic and advanced.
88

guides/administrator-guides/white-labeling/advanced-white-labeling.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
In these guides we will cover how to customize styling in more depth and how to add custom Javascript scripts to your server.
44

5-
Please use caution when using these settings, as the misuse of them can cause problems on your server
5+
Please use caution when using these settings, as the misuse of them can cause problems on your server.
66

77
## Custom CSS
88

9-
Can be found in Administration => Layout. This allows you to overwrite styling on ui. For the full maestry of this setting we recommend studying the source code, as seen that overwriting classes directly can lead to side effects on styling.
9+
Can be found in Administration => Layout. This allows you to overwrite styling on UI. For the full maestry of this setting we recommend studying the source code, as seen that overwriting classes directly can lead to side effects on styling.
1010

1111
### CSS Variables
1212

13-
Rocket.Chat uses css variables to store key values when styling. Rocket.Chat recommends only overwriting the css variables, as you will have more control on what will be changed.
13+
Rocket.Chat uses CSS variables to store key values when styling. Rocket.Chat recommends only overwriting the CSS variables, as you will have more control on what will be changed.
1414

15-
You can find the full list of variables here
15+
You can find the full list of variables [here](https://github.com/RocketChat/Rocket.Chat/blob/84d547055ea1ce08e55d7a95ed99dd9c0be852b9/app/theme/client/imports/general/variables.css).
1616

1717
## Custom Scripts
1818

@@ -24,26 +24,28 @@ This script runs after the user has logged out.
2424

2525
### Custom Script for Logged Out Users
2626

27-
Custom Script that will run whenever a user that is not logged in accesses your server url. e.g. \(whenever you enter the login page\)
27+
Custom Script that will run whenever a user that is not logged in accesses your server url. E.g. \(whenever you enter the login page\)
2828

2929
### Custom Script for Logged In Users
3030

31-
Custom Script that will run whenever a user that is logged in accesses your server url \(eg. opens a browser page or the desktop app\)
31+
Custom Script that will run whenever a user that is logged in accesses your server url \(eg. opens a browser page or the desktop app\).
3232

3333
## Email Templates
3434

35-
Here you can configure various email settings, in this guide we will be going over only email templating sections. Found in the administration menu. Here you can use HTML for formatting. You can also use placeholders that will be changed to actual data when sending \(for example \[email\] will turn into the user's email\). You can also use Rocket.Chat internationalization engine by wrapping the sentence string with `{}`, see all our internationalization strings [here](https://github.com/RocketChat/Rocket.Chat/blob/develop/packages/rocketchat-i18n/i18n/en.i18n.json#L1198)
35+
Here you can configure various email settings, in this guide we will be going over only email templating sections. Found in the administration menu. Here you can use HTML for formatting. You can also use placeholders that will be changed to actual data when sending \(for example \[email\] will turn into the user's email\). You can also use Rocket.Chat internationalization engine by wrapping the sentence string with `{}`, see all our internationalization strings [here](https://github.com/RocketChat/Rocket.Chat/blob/develop/packages/rocketchat-i18n/i18n/en.i18n.json#L1198).
3636

3737
### Email Address Changed
3838

39-
Informs that the user has changed the email Is triggered when the user changes the email You may use the following placeholders:
39+
Informs that the user has changed the email Is triggered when the user changes the email.
40+
41+
You may use the following placeholders:
4042

4143
* \[email\] for the user's email.
4244
* \[Site\_Name\] and \[Site\_URL\] for the Application Name and URL respectively.
4345

4446
### Forgot Password
4547

46-
Resets the password Is triggered when the user clicks on 'Forgot Password'
48+
Resets the password Is triggered when the user clicks on 'Forgot Password'.
4749

4850
You may use the following placeholders:
4951

@@ -54,13 +56,15 @@ You may use the following placeholders:
5456

5557
### Header and Footer
5658

57-
Any changes made here will be reflected in the every header and footer Changes the header, footer and direct reply warning HTML You may use the following placeholders:
59+
Any changes made here will be reflected in the every header and footer. Changes the header, footer and direct reply warning HTML.
60+
61+
You may use the following placeholders:
5862

5963
* \[Site\_Name\] and \[Site\_URL\] for the Application Name and URL respectively.
6064

6165
### Invitation
6266

63-
Invitation to use the site Is triggered when the admin invites the person by email
67+
Invitation to use the site. Is triggered when the admin invites the person by email.
6468

6569
You may use the following placeholders:
6670

@@ -69,7 +73,9 @@ You may use the following placeholders:
6973

7074
### Password Changed
7175

72-
Informs that the password has been changed by the admin Is triggered when the admin change user's password You may use the following placeholders:
76+
Informs that the password has been changed by the admin. Is triggered when the admin change user's password.
77+
78+
You may use the following placeholders:
7379

7480
* \[password\] for the temporary password.
7581
* \[name\], \[fname\], \[lname\] for the user's full name, first name or last name, respectively.
@@ -78,15 +84,19 @@ Informs that the password has been changed by the admin Is triggered when the ad
7884

7985
### Registration
8086

81-
Is triggered when the user registers You may use the following placeholders:
87+
Is triggered when the user registers.
88+
89+
You may use the following placeholders:
8290

8391
* \[name\], \[fname\], \[lname\] for the user's full name, first name or last name, respectively.
8492
* \[email\] for the user's email.
8593
* \[Site\_Name\] and \[Site\_URL\] for the Application Name and URL respectively.
8694

8795
### Registration via Admin
8896

89-
Is triggered when the admin creates an account for the user You may use the following placeholders:
97+
Is triggered when the admin creates an account for the user.
98+
99+
You may use the following placeholders:
90100

91101
* \[name\], \[fname\], \[lname\] for the user's full name, first name or last name, respectively.
92102
* \[email\] for the user's email.
@@ -99,29 +109,37 @@ Here you can edit the emails styling using CSS.
99109

100110
### Subject
101111

102-
Here you can define what email users will receive when they recieve certain message notifications:
112+
Here you can define what email users will receive when they recieve certain message notifications.
103113

104114
### Direct Message:
105115

106-
Is triggered when a user receives a direct message. You may use the following placeholders:
116+
Is triggered when a user receives a direct message.
117+
118+
You may use the following placeholders:
107119

108120
* \[Site\_Name\], \[Site\_URL\], \[User\] & \[Room\] for the Application Name, URL, Username and Roomname respectively.
109121

110122
### Mention:
111123

112-
Is triggered when a user is mentioned using `@username`. You may use the following placeholders:
124+
Is triggered when a user is mentioned using `@username`.
125+
126+
You may use the following placeholders:
113127

114128
* \[Site\_Name\], \[Site\_URL\], \[User\] & \[Room\] for the Application Name, URL, Username and Roomname respectively.
115129

116130
### Mention All:
117131

118-
Is triggered when a user is mentioned using `@all`. You may use the following placeholders:
132+
Is triggered when a user is mentioned using `@all`.
133+
134+
You may use the following placeholders:
119135

120136
* \[Site\_Name\], \[Site\_URL\], \[User\] & \[Room\] for the Application Name, URL, Username and Roomname respectively.
121137

122138
### Verification
123139

124-
Email that the user receives to verify his account. You may use the following placeholders:
140+
Email that the user receives to verify his account.
141+
142+
You may use the following placeholders:
125143

126144
* \[Verification\_Url\] for the verification URL.
127145
* \[name\], \[fname\], \[lname\] for the user's full name, first name or last name, respectively.

0 commit comments

Comments
 (0)