You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Correcting typos/adding consistency for the Administrator Guides in: cdn, data-base-migration, dashboard, general, notifications, white-labeling (RocketChat#1944)
Copy file name to clipboardExpand all lines: guides/administrator-guides/cdn.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,11 +40,11 @@ If the situation occurs where CDN stops working or the provided values are incor
40
40
41
41
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.
@@ -23,19 +23,19 @@ In order to connect your server to our Cloud, your Rocket.Chat server must be at
23
23
24
24
**If you don't have a cloud account yet:**
25
25
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.
27
27
28
28

29
29
30
-
2. Fill up the registration form and "Register"
30
+
2. Fill up the registration form and "Register".
31
31
32
32

33
33
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.
35
35
36
36

37
37
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.
39
39
40
40

41
41
@@ -44,7 +44,7 @@ In order to connect your server to our Cloud, your Rocket.Chat server must be at
44
44
* Internet Access: Rocket.Chat server that has a connection to the internet \(connected to the outside\)
45
45
* No Internet Access: Special cases where Rocket.Chat server has no connection at all \(totally air-gapped\).
46
46
47
-
In this document, we are covering only the "Internet Access" option
47
+
In this document, we are covering only the "Internet Access" option.
48
48
49
49
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.
50
50
@@ -63,10 +63,10 @@ Fill up the "Email" field with the email related to your Rocket.Chat Cloud accou
63
63
64
64
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.
65
65
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/).
67
67
68
68
{% 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**.
Restart Rocket.Chat and the migration should succeed now to the latest version.
34
34
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.
@@ -72,7 +72,7 @@ It represents the time by day or hour when your chat is busier, as shown below:
72
72
73
73
## Messages
74
74
75
-
The Messages tab shows you the following engagement matrices.
75
+
The Messages tab shows you the following engagement matrices:
76
76
77
77

78
78
@@ -94,7 +94,7 @@ It represents the public, private, and top 5 most popular channel to which the m
94
94
95
95
## Channels
96
96
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:
Copy file name to clipboardExpand all lines: guides/administrator-guides/general.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ If you are integrating Bugsnag with Rocket.Chat, you should put your Bugsnag API
12
12
13
13
### CDN Prefix for JS/CSS
14
14
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.
16
16
17
17
### CDN Prefix
18
18
@@ -33,7 +33,7 @@ Insert here the name of the channel that the user will enter after logging in. S
33
33
34
34
### Force Disable OpLog for Cache
35
35
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.
37
37
38
38
### Force SSL
39
39
@@ -73,20 +73,20 @@ This sets the URL of the server.
73
73
74
74
### Store Last Message
75
75
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\).
77
77
78
78
### Unread Count
79
79
80
-
This setting changes the behavior of the unread counter
80
+
This setting changes the behavior of the unread counter.
81
81
82
82
***All messages**: All messages will be counted on the counter, regardless if they are a mention or not.
83
83
***User mentions only**: Only mentions using `@yourUsername` will be counted on the counter.
84
84
***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`.
86
86
87
87
### Unread Count for Direct Messages
88
88
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.
90
90
91
91
***All messages**: All messages sent by another user will be counted on the counter.
92
92
***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.
131
131
132
132
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)
133
133
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.
135
135
***No**: Setting the number `0` on `count`, will return `0` results.
136
136
137
137
> 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
140
140
141
141
Here you can set what origins are allowed to make requests to your server.
142
142
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`
144
144
145
145
### Default Count
146
146
@@ -164,11 +164,11 @@ Enables the usage of [Shields](https://developer.rocket.chat/api/rest-api/method
164
164
165
165
### Shield Types
166
166
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.
168
168
169
169
### Max Record Amount
170
170
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.
172
172
173
173
### User Limit for Adding All Users to Channel
174
174
@@ -209,7 +209,7 @@ Should be a valid JSON where keys are languages containing a dictionary of key a
209
209
210
210
### UTF8 Names Validation
211
211
212
-
RegExp that will be used to validate usernames and channel names
212
+
RegExp that will be used to validate usernames and channel names.
213
213
214
214
> **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.
Copy file name to clipboardExpand all lines: guides/administrator-guides/notifications.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,5 +18,5 @@ Notifications of direct messages or mentions by @username are sent by Email to y
18
18
19
19
## Mentions
20
20
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.
Copy file name to clipboardExpand all lines: guides/administrator-guides/white-labeling/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
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.
4
4
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).
6
6
7
7
We will be separating these guides into 2 categories: basic and advanced.
Copy file name to clipboardExpand all lines: guides/administrator-guides/white-labeling/advanced-white-labeling.md
+37-19Lines changed: 37 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,17 @@
2
2
3
3
In these guides we will cover how to customize styling in more depth and how to add custom Javascript scripts to your server.
4
4
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.
6
6
7
7
## Custom CSS
8
8
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.
10
10
11
11
### CSS Variables
12
12
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.
14
14
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).
16
16
17
17
## Custom Scripts
18
18
@@ -24,26 +24,28 @@ This script runs after the user has logged out.
24
24
25
25
### Custom Script for Logged Out Users
26
26
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\)
28
28
29
29
### Custom Script for Logged In Users
30
30
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\).
32
32
33
33
## Email Templates
34
34
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).
36
36
37
37
### Email Address Changed
38
38
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:
40
42
41
43
*\[email\] for the user's email.
42
44
*\[Site\_Name\] and \[Site\_URL\] for the Application Name and URL respectively.
43
45
44
46
### Forgot Password
45
47
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'.
47
49
48
50
You may use the following placeholders:
49
51
@@ -54,13 +56,15 @@ You may use the following placeholders:
54
56
55
57
### Header and Footer
56
58
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:
58
62
59
63
*\[Site\_Name\] and \[Site\_URL\] for the Application Name and URL respectively.
60
64
61
65
### Invitation
62
66
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.
64
68
65
69
You may use the following placeholders:
66
70
@@ -69,7 +73,9 @@ You may use the following placeholders:
69
73
70
74
### Password Changed
71
75
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:
73
79
74
80
*\[password\] for the temporary password.
75
81
*\[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
78
84
79
85
### Registration
80
86
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:
82
90
83
91
*\[name\], \[fname\], \[lname\] for the user's full name, first name or last name, respectively.
84
92
*\[email\] for the user's email.
85
93
*\[Site\_Name\] and \[Site\_URL\] for the Application Name and URL respectively.
86
94
87
95
### Registration via Admin
88
96
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:
90
100
91
101
*\[name\], \[fname\], \[lname\] for the user's full name, first name or last name, respectively.
92
102
*\[email\] for the user's email.
@@ -99,29 +109,37 @@ Here you can edit the emails styling using CSS.
99
109
100
110
### Subject
101
111
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.
103
113
104
114
### Direct Message:
105
115
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:
107
119
108
120
*\[Site\_Name\], \[Site\_URL\], \[User\] & \[Room\] for the Application Name, URL, Username and Roomname respectively.
109
121
110
122
### Mention:
111
123
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:
113
127
114
128
*\[Site\_Name\], \[Site\_URL\], \[User\] & \[Room\] for the Application Name, URL, Username and Roomname respectively.
115
129
116
130
### Mention All:
117
131
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:
119
135
120
136
*\[Site\_Name\], \[Site\_URL\], \[User\] & \[Room\] for the Application Name, URL, Username and Roomname respectively.
121
137
122
138
### Verification
123
139
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:
125
143
126
144
*\[Verification\_Url\] for the verification URL.
127
145
*\[name\], \[fname\], \[lname\] for the user's full name, first name or last name, respectively.
0 commit comments