Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit e5b76bc

Browse files
Simran-Bnerpaula
andauthored
Use more Inclusive language and examples (#1195)
* Use more inclusive language * Improve examples Co-authored-by: Paula Mihu <97217318+nerpaula@users.noreply.github.com>
1 parent ce7d8a6 commit e5b76bc

33 files changed

+130
-126
lines changed

3.10/administration-managing-users.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ There are a few differences to *normal* ArangoDB users:
350350
To grant access for an LDAP user you will need to create *roles* within the
351351
ArangoDB server. A role is just a user with the `:role:` prefix in its name.
352352
Role users cannot login as database users, the `:role:` prefix ensures this.
353-
Your LDAP users will need to have at least one role, once the user logs in he
354-
will be automatically granted the union of all access rights of all his roles.
353+
Your LDAP users will need to have at least one role; once users log in they
354+
will be automatically granted the union of all access rights of all their roles.
355355
Note that a lower right grant in one role will be overwritten by a higher
356356
access grant in a different role.

3.10/aql/examples-data-modification-queries.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ documents:
2323

2424
```aql
2525
FOR u IN users
26-
UPDATE u WITH { gender: TRANSLATE(u.gender, { m: 'male', f: 'female' }) } IN users
26+
UPDATE u WITH { gender: TRANSLATE(u.gender, { m: 'male', f: 'female', x: 'diverse' }) } IN users
2727
```
2828

2929
To add new attributes to existing documents, we can also use an `UPDATE` query.
@@ -130,11 +130,10 @@ FOR i IN 1..1000
130130
age: 18 + FLOOR(RAND() * 25),
131131
name: CONCAT('test', TO_STRING(i)),
132132
active: false,
133-
gender: i % 2 == 0 ? 'male' : 'female'
133+
gender: i % 3 == 0 ? 'male' : i % 3 == 1 ? 'female' : 'diverse'
134134
} IN users
135135
```
136136

137-
138137
Copying data from one collection into another
139138
---------------------------------------------
140139

3.10/aql/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ with the following initial data:
5858
{ "id": 200, "name": "Sophia", "age": 37, "active": true, "gender": "f" },
5959
{ "id": 201, "name": "Emma", "age": 36, "active": true, "gender": "f" },
6060
{ "id": 202, "name": "Olivia", "age": 35, "active": false, "gender": "f" },
61-
{ "id": 203, "name": "Madison", "age": 34, "active": true, "gender": "f" },
61+
{ "id": 203, "name": "Madison", "age": 34, "active": true, "gender": "x" },
6262
{ "id": 204, "name": "Chloe", "age": 33, "active": true, "gender": "f" },
6363
{ "id": 205, "name": "Eva", "age": 32, "active": false, "gender": "f" },
6464
{ "id": 206, "name": "Abigail", "age": 31, "active": true, "gender": "f" },

3.10/aql/graphs-shortest-path.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ We start with the shortest path from **A** to **D** as above:
163163
{% include arangoshexample.html id=examplevar script=script result=result %}
164164

165165
We can see our expectations are fulfilled. We find the vertices in the correct ordering and
166-
the first edge is *null*, because no edge is pointing to the start vertex on t his path.
166+
the first edge is *null*, because no edge is pointing to the start vertex on this path.
167167

168168
We can also compute shortest paths based on documents found in collections:
169169

3.10/aql/operations-filter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ FOR u IN users
112112
RETURN u
113113
```
114114

115-
This will return the users *Mariah* and *Mary*. If sorted by age in `DESC` order,
116-
then the Sophia, Emma and Madison documents are returned. A `FILTER` after a
115+
This will return the users *Mariah*, *Mary*, and *Isabella*. If sorted by age in
116+
`DESC` order, then the *Sophia* and *Emma* documents are returned. A `FILTER` after a
117117
`LIMIT` is not very common however, and you probably want such a query instead:
118118

119119
```aql

3.10/arangosync.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ load, network & computer capacity.
4242

4343
_ArangoSync_ performs replication in a **single direction** only. That means that
4444
you can replicate data from cluster _A_ to cluster _B_ or from cluster _B_ to
45-
cluster _A_, but never at the same time (one master, one or more slave clusters).
45+
cluster _A_, but never at the same time (one leader, one or more follower clusters).
4646
<br/>Data modified in the destination cluster **will be lost!**
4747

4848
Replication is a completely **autonomous** process. Once it is configured it is
@@ -51,14 +51,14 @@ designed to run 24/7 without frequent manual intervention.
5151
<br/>As with any distributed system some attention is needed to monitor its operation
5252
and keep it secure (e.g. certificate & password rotation).
5353

54-
In the event of an outage of the master cluster, user intervention is required
55-
to either bring the master back up or to decide on making a slave cluster the
56-
new master. There is no automatic failover as slave clusters lag behind the master
57-
because of network latency etc. and resuming operation with the state of a slave
54+
In the event of an outage of the leader cluster, user intervention is required
55+
to either bring the leader back up or to decide on making a follower cluster the
56+
new leader. There is no automatic failover as follower clusters lag behind the leader
57+
because of network latency etc. and resuming operation with the state of a follower
5858
cluster can therefore result in the loss of recent writes. How much can be lost
59-
largely depends on the data rate of the master cluster and the delay between
60-
the master and the slaves. Slaves will typically be behind the master by a couple
61-
of seconds or minutes.
59+
largely depends on the data rate of the leader cluster and the delay between
60+
the leader and the follower clusters. Followers will typically be behind the
61+
leader by a couple of seconds or minutes.
6262

6363
Once configured, _ArangoSync_ will replicate both **structure and data** of an
6464
**entire cluster**. This means that there is no need to make additional configuration

3.10/deployment-cluster-using-the-starter.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,15 +134,16 @@ docker run -it --name=adb --rm -p 8528:8528 \
134134

135135
Under the Hood
136136
--------------
137-
The first `arangodb` you ran will become the _master_ of your _Starter_
138-
setup, the other `arangodb` instances will become the _slaves_ of your _Starter_
139-
setup. Please do not confuse the terms _master_ and _slave_ above with the Leader/Follower
140-
("master/slave") technology of ArangoDB. The terms above refers to the _Starter_ setup.
141137

142-
The _Starter_ _master_ determines which ArangoDB server processes to launch on which
143-
_Starter_ _slave_, and how they should communicate.
138+
The first `arangodb` you ran will become the _leader_ of your _Starter_ setup
139+
(also called _master_), the other `arangodb` instances will become the
140+
_followers_ of your _Starter_ setup. This is not to be confused with the
141+
Leader/Follower replication of ArangoDB. The terms above refers to the _Starter_ setup.
142+
143+
The _Starter_ _leader_ determines which ArangoDB server processes to launch on which
144+
_Starter_ _follower_, and how they should communicate.
144145

145146
It will then launch the server processes and monitor them. Once it has detected
146147
that the setup is complete you will get the prompt.
147148

148-
The _Starter_ _master_ will save the setup for subsequent starts.
149+
The _Starter_ _leader_ will save the setup for subsequent starts.

3.10/deployment-dc2dc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ more information.
4141
The Sync Master is responsible for managing all synchronization, creating tasks and assigning
4242
those to workers.
4343
<br/> At least 2 instances must be deployed in each datacenter.
44-
One instance will be the "leader", the other will be an inactive slave. When the leader
45-
is gone for a short while, one of the other instances will take over.
44+
One instance will be the leader cluster, the other will be an inactive follower cluster.
45+
When the leader is gone for a short while, one of the other instances will take over.
4646

4747
With clusters of a significant size, the sync master will require a significant set of resources.
4848
Therefore it is recommended to deploy sync masters on their own servers, equipped with sufficient

3.10/graphs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ We can use an edge collection to store relations between users and groups. Since
169169
number of groups, this is an **m:n** relation. The edge collection can be called `UsersInGroups` with i.e. one edge
170170
with `_from` pointing to `Users/John` and `_to` pointing to `Groups/BowlingGroupHappyPin`. This makes the user **John**
171171
a member of the group **Bowling Group Happy Pin**. Attributes of this relation may contain qualifiers to this relation,
172-
like the permissions of **John** in this group, the date when he joined the group etc.
172+
like the permissions of **John** in this group, the date when John joined the group etc.
173173

174174
![User in group example](images/graph_user_in_group.png)
175175

3.10/http/bulk-imports-importing-headers-and-values.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ curl --data-binary @- -X POST --dump - "http://localhost:8529/_api/import?collec
1919
[ "firstName", "lastName", "age", "gender" ]
2020
[ "Joe", "Public", 42, "male" ]
2121
[ "Jane", "Doe", 31, "female" ]
22+
[ "Robin", "Mayfield", 56, "diverse" ]
2223

2324
HTTP/1.1 201 Created
2425
Server: ArangoDB
2526
Connection: Keep-Alive
2627
Content-type: application/json; charset=utf-8
2728

28-
{"error":false,"created":2,"empty":0,"errors":0}
29+
{"error":false,"created":3,"empty":0,"errors":0}
2930
```
3031

3132
The server will again respond with an HTTP 201 if everything went well. The

0 commit comments

Comments
 (0)