Skip to content

Commit a16bcd1

Browse files
Inclusivity changes for CloudStack in the documentation - Rename default git branch name from 'master' to 'main' and replace some offensive words/terms as appropriate (#155)
* Renamed default git branch name from 'master' to 'main', for inclusiveness. * Updated master and slave(s) in the database context, with source and replica(s) respectively for inclusiveness. * Updated the configurations 'user.vm.blacklisted.details' and 'blacklisted.routes', to 'user.vm.denied.details' and 'denied.routes' respectively and other related offending words for inclusiveness. * Updated redundant state of router from 'master' to 'primary', to be more inclusive. * Updated whitelist, blacklist, master, slave and some other offensive words/terms as appropriate for inclusiveness. * Updated kubernetes service docs with inclusive words/terms. * Update some doc with gender-inclusive words * Reverted Sphinx conf changes Co-authored-by: Suresh Kumar Anaparti <suresh.anaparti@shapeblue.com> Co-authored-by: sureshanaparti <12028987+sureshanaparti@users.noreply.github.com>
1 parent 98a17e8 commit a16bcd1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+261
-258
lines changed

README.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,15 @@ On your computer, follow these steps to setup a local repository for working on
9292
$ git clone https://github.com/YOUR_ACCOUNT/cloudstack-documentation.git
9393
$ cd cloudstack-docs-install
9494
$ git remote add upstream https://github.com/apache/cloudstack-documentation.git
95-
$ git checkout master
95+
$ git checkout main
9696
$ git fetch upstream
97-
$ git merge upstream/master
97+
$ git merge upstream/main
9898
9999
100100
Making changes
101101
--------------
102102

103-
It is important that you create a new branch to make changes on and that you do not change the `master` branch (other than to pull in changes from `upstream/master`). In this case I will assume you will be creating a branch called `dev` to make your changes in. This `dev` branch will be created on your local repository and will then be pushed to your forked repository on GitHub where you will create a Pull Request for the changes to be committed into the official documentation.
103+
It is important that you create a new branch to make changes on and that you do not change the `main` branch (other than to pull in changes from `upstream/main`). In this case I will assume you will be creating a branch called `dev` to make your changes in. This `dev` branch will be created on your local repository and will then be pushed to your forked repository on GitHub where you will create a Pull Request for the changes to be committed into the official documentation.
104104

105105
It is good practice to create a new branch each time you want to contribute to the documentation and only track the changes for that pull request in this branch.
106106

@@ -115,40 +115,40 @@ It is good practice to create a new branch each time you want to contribute to t
115115
The `-b` specifies that you want to create a new branch called `dev`. You only specify `-b` the first time because you are creating a new branch. Once the `dev` branch exists, you can later switch to it with only `git checkout dev`.
116116

117117

118-
Merging `upstream/master` into your `dev` branch
118+
Merging `upstream/main` into your `dev` branch
119119
------------------------------------------------
120120

121-
It is important that you maintain an up-to-date `master` branch in your local repository. This is done by merging in the `upstream/master` (the official documentation repository) into your local repository. You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. You can also do this process periodically while you work on your changes to make sure you are working off the most recent version of the documentation.
121+
It is important that you maintain an up-to-date `main` branch in your local repository. This is done by merging in the `upstream/main` (the official documentation repository) into your local repository. You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. You can also do this process periodically while you work on your changes to make sure you are working off the most recent version of the documentation.
122122

123123
This process will do the following:
124124

125-
#. Checkout your local `master` branch
125+
#. Checkout your local `main` branch
126126

127-
#. Synchronize your local `master` branch with the `upstream/master` so you have all the latest changes from the official docs
127+
#. Synchronize your local `main` branch with the `upstream/main` so you have all the latest changes from the official docs
128128

129129
#. Merge the latest changes from the official docs into your `dev` branch so it is up-to-date with the latest changes
130130

131131
.. code:: bash
132132
133-
$ git checkout master
133+
$ git checkout main
134134
$ git fetch upstream
135-
$ git merge upstream/master
135+
$ git merge upstream/main
136136
$ git checkout dev
137-
$ git pull . master
137+
$ git pull . main
138138
139-
.. note:: Now your `dev` branch is up-to-date with all the recent changes in the `upstream/master`.
139+
.. note:: Now your `dev` branch is up-to-date with all the recent changes in the `upstream/main`.
140140

141141

142142
Making a pull request on GitHub to contribute your changes
143143
----------------------------------------------------------
144144

145145
When you are happy with your changes and you want to contribute them, you will be creating a Pull Request on GitHub to do so. This is done by pushing your changes to your forked repository (usually called 'origin') and then initiating a pull request.
146146

147-
.. note:: Make sure you have merged `upstream/master` into your `dev` branch before you do this.
147+
.. note:: Make sure you have merged `upstream/main` into your `dev` branch before you do this.
148148

149149
.. code:: bash
150150
151-
$ git push origin master
151+
$ git push origin main
152152
$ git push origin dev
153153
154154
Now that the `dev` branch has been pushed to your GitHub repository, you can initiate the pull request.
@@ -167,14 +167,14 @@ If you are requested to make modifications to your proposed changes, make the ch
167167
Cleaning up after a successful pull request
168168
-------------------------------------------
169169

170-
Once the `dev` branch has been committed into the `upstream/master` branch, your local `dev` branch and the `origin/dev` branch are not needed anymore. If you want to make additional documentation changes, restart the process with a new branch.
170+
Once the `dev` branch has been committed into the `upstream/main` branch, your local `dev` branch and the `origin/dev` branch are not needed anymore. If you want to make additional documentation changes, restart the process with a new branch.
171171

172-
.. note:: Make sure that your changes are in `upstream/master` before you delete your `dev` and `origin/dev` branches!
172+
.. note:: Make sure that your changes are in `upstream/main` before you delete your `dev` and `origin/dev` branches!
173173

174174
You can delete these deprecated branches with the following:
175175

176176
.. code:: bash
177177
178-
$ git checkout master
178+
$ git checkout main
179179
$ git branch -D dev
180180
$ git push origin :dev

source/adminguide/autoscale_without_netscaler.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
Configuring AutoScale without using NetScaler
1818
=============================================
1919

20-
.. warning::
21-
This feature is currently only available on the master branch and will be
20+
.. warning::
21+
This feature is currently only available on the main branch and will be
2222
released in the 4.4 release.
2323

2424
.. note::

source/adminguide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
specific language governing permissions and limitations
1414
under the License.
1515
16-
.. CloudStack Administration Documentation master file, created by
16+
.. CloudStack Administration Documentation main file, created by
1717
sphinx-quickstart on Sat Jan 25 15:55:12 2014.
1818
You can adapt this file completely to your liking, but it should at least
1919
contain the root `toctree` directive.

source/adminguide/locale/pot/networking.pot

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -730,7 +730,7 @@ msgstr ""
730730

731731
#: ../../networking.rst:369
732732
# 6c9c68a68ab14d30a00460dd3b13f8a6
733-
msgid "**Redundant router capability**: Available only when Virtual Router is selected as the Source NAT provider. Select this option if you want to use two virtual routers in the network for uninterrupted connection: one operating as the master virtual router and the other as the backup. The master virtual router receives requests from and sends responses to the user’s VM. The backup virtual router is activated only when the master is down. After the failover, the backup becomes the master virtual router. CloudStack deploys the routers on different hosts to ensure reliability if one host is down."
733+
msgid "**Redundant router capability**: Available only when Virtual Router is selected as the Source NAT provider. Select this option if you want to use two virtual routers in the network for uninterrupted connection: one operating as the primary virtual router and the other as the backup. The primary virtual router receives requests from and sends responses to the user’s VM. The backup virtual router is activated only when the primary is down. After the failover, the backup becomes the primary virtual router. CloudStack deploys the routers on different hosts to ensure reliability if one host is down."
734734
msgstr ""
735735

736736
#: ../../networking.rst:380

source/adminguide/locale/pot/networking/virtual_private_cloud_config.pot

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1222,12 +1222,12 @@ msgstr ""
12221222

12231223
#: ../../networking/virtual_private_cloud_config.rst:648
12241224
# f66d2b908d63453ba9331658c3105974
1225-
msgid "Blacklisting Routes"
1225+
msgid "Denylisting Routes"
12261226
msgstr ""
12271227

12281228
#: ../../networking/virtual_private_cloud_config.rst:650
12291229
# 5e262d8f57f94df080de1ebfd57089c5
1230-
msgid "CloudStack enables you to block a list of routes so that they are not assigned to any of the VPC private gateways. Specify the list of routes that you want to blacklist in the ``blacklisted.routes`` global parameter. Note that the parameter update affects only new static route creations. If you block an existing static route, it remains intact and continue functioning. You cannot add a static route if the route is blacklisted for the zone."
1230+
msgid "CloudStack enables you to block a list of routes so that they are not assigned to any of the VPC private gateways. Specify the list of routes that you want to denylist in the ``denied.routes`` global parameter. Note that the parameter update affects only new static route creations. If you block an existing static route, it remains intact and continue functioning. You cannot add a static route if the route is denied for the zone."
12311231
msgstr ""
12321232

12331233
#: ../../networking/virtual_private_cloud_config.rst:660

source/adminguide/locale/pot/networking2.pot

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5988,12 +5988,12 @@ msgstr ""
59885988

59895989
#: ../../networking2.rst:5737
59905990
# 4bb61ba3dd1444269d2f517a3d774dac
5991-
msgid "Blacklisting Routes"
5991+
msgid "Denylisting Routes"
59925992
msgstr ""
59935993

59945994
#: ../../networking2.rst:5739
59955995
# bf15aaf7395c48438bdfb1c5a1b303cd
5996-
msgid "CloudStack enables you to block a list of routes so that they are not assigned to any of the VPC private gateways. Specify the list of routes that you want to blacklist in the ``blacklisted.routes`` global parameter. Note that the parameter update affects only new static route creations. If you block an existing static route, it remains intact and continue functioning. You cannot add a static route if the route is blacklisted for the zone."
5996+
msgid "CloudStack enables you to block a list of routes so that they are not assigned to any of the VPC private gateways. Specify the list of routes that you want to denylist in the ``denied.routes`` global parameter. Note that the parameter update affects only new static route creations. If you block an existing static route, it remains intact and continue functioning. You cannot add a static route if the route is denied for the zone."
59975997
msgstr ""
59985998

59995999
#: ../../networking2.rst:5748

source/adminguide/locale/pot/networking_and_traffic.pot

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5979,12 +5979,12 @@ msgstr ""
59795979

59805980
#: ../../networking/virtual_private_cloud_config.rst:648
59815981
# f5f80f387b5246caa603111d30dcfab7
5982-
msgid "Blacklisting Routes"
5982+
msgid "Denylisting Routes"
59835983
msgstr ""
59845984

59855985
#: ../../networking/virtual_private_cloud_config.rst:650
59865986
# 8515025cd30a4b30b46f527ea9be5b2b
5987-
msgid "CloudStack enables you to block a list of routes so that they are not assigned to any of the VPC private gateways. Specify the list of routes that you want to blacklist in the ``blacklisted.routes`` global parameter. Note that the parameter update affects only new static route creations. If you block an existing static route, it remains intact and continue functioning. You cannot add a static route if the route is blacklisted for the zone."
5987+
msgid "CloudStack enables you to block a list of routes so that they are not assigned to any of the VPC private gateways. Specify the list of routes that you want to denylist in the ``denied.routes`` global parameter. Note that the parameter update affects only new static route creations. If you block an existing static route, it remains intact and continue functioning. You cannot add a static route if the route is denied for the zone."
59885988
msgstr ""
59895989

59905990
#: ../../networking/virtual_private_cloud_config.rst:660

source/adminguide/locale/pot/reliability.pot

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -283,22 +283,22 @@ msgstr ""
283283

284284
#: ../../reliability.rst:207
285285
# 147ac9efb2314312b6e97323a267fd7c
286-
msgid "``db.cloud.slaves``: set to a comma-delimited set of slave hosts for the cloud database. This is the list of nodes set up with replication. The master node is not in the list, since it is already mentioned elsewhere in the properties file."
286+
msgid "``db.cloud.replicas``: set to a comma-delimited set of replica hosts for the cloud database. This is the list of nodes set up with replication. The source node is not in the list, since it is already mentioned elsewhere in the properties file."
287287
msgstr ""
288288

289289
#: ../../reliability.rst:212
290290
# aa38f185ca8b4c1b86e19da970eb3901
291-
msgid "Example: ``db.cloud.slaves=node2,node3,node4``"
291+
msgid "Example: ``db.cloud.replicas=node2,node3,node4``"
292292
msgstr ""
293293

294294
#: ../../reliability.rst:214
295295
# 1783ef0808884e28ab22f6b3172dba41
296-
msgid "``db.usage.slaves``: set to a comma-delimited set of slave hosts for the usage database. This is the list of nodes set up with replication. The master node is not in the list, since it is already mentioned elsewhere in the properties file."
296+
msgid "``db.usage.replicas``: set to a comma-delimited set of replica hosts for the usage database. This is the list of nodes set up with replication. The source node is not in the list, since it is already mentioned elsewhere in the properties file."
297297
msgstr ""
298298

299299
#: ../../reliability.rst:219
300300
# 573fb04445dd4b0ba4f5b9a5f8517c75
301-
msgid "Example: ``db.usage.slaves=node2,node3,node4``"
301+
msgid "Example: ``db.usage.replicas=node2,node3,node4``"
302302
msgstr ""
303303

304304
#: ../../reliability.rst:221
@@ -313,27 +313,27 @@ msgstr ""
313313

314314
#: ../../reliability.rst:227
315315
# bcfa8dcb331c4185bab0cbdfbb3624ca
316-
msgid "``db.cloud.secondsBeforeRetryMaster``: The number of seconds the MySQL connector should wait before trying again to connect to the master after the master went down. Default is 1 hour. The retry might happen sooner if db.cloud.queriesBeforeRetryMaster is reached first."
316+
msgid "``db.cloud.secondsBeforeRetrySource``: The number of seconds the MySQL connector should wait before trying again to connect to the source after the source went down. Default is 1 hour. The retry might happen sooner if db.cloud.queriesBeforeRetrySource is reached first."
317317
msgstr ""
318318

319319
#: ../../reliability.rst:232
320320
# 55d7217f8ea6408e8389bd39dbbfc3fc
321-
msgid "Example: ``db.cloud.secondsBeforeRetryMaster=3600``"
321+
msgid "Example: ``db.cloud.secondsBeforeRetrySource=3600``"
322322
msgstr ""
323323

324324
#: ../../reliability.rst:234
325325
# d8cfb3b10706434d8ad7c63b231e7ee9
326-
msgid "``db.cloud.queriesBeforeRetryMaster``: The minimum number of queries to be sent to the database before trying again to connect to the master after the master went down. Default is 5000. The retry might happen sooner if db.cloud.secondsBeforeRetryMaster is reached first."
326+
msgid "``db.cloud.queriesBeforeRetrySource``: The minimum number of queries to be sent to the database before trying again to connect to the source after the source went down. Default is 5000. The retry might happen sooner if db.cloud.secondsBeforeRetrySource is reached first."
327327
msgstr ""
328328

329329
#: ../../reliability.rst:239
330330
# f7b672a867c64854accef70177a0dd73
331-
msgid "Example: ``db.cloud.queriesBeforeRetryMaster=5000``"
331+
msgid "Example: ``db.cloud.queriesBeforeRetrySource=5000``"
332332
msgstr ""
333333

334334
#: ../../reliability.rst:241
335335
# 2283aca3081443c585804a3c9d63a45d
336-
msgid "``db.cloud.initialTimeout``: Initial time the MySQL connector should wait before trying again to connect to the master. Default is 3600."
336+
msgid "``db.cloud.initialTimeout``: Initial time the MySQL connector should wait before trying again to connect to the source. Default is 3600."
337337
msgstr ""
338338

339339
#: ../../reliability.rst:244
@@ -353,7 +353,7 @@ msgstr ""
353353

354354
#: ../../reliability.rst:253
355355
# 7c4a38ab45c943a489f2e7ae8f3ab0e2
356-
msgid "Slave hosts can not be monitored through CloudStack. You will need to have a separate means of monitoring."
356+
msgid "Replica hosts can not be monitored through CloudStack. You will need to have a separate means of monitoring."
357357
msgstr ""
358358

359359
#: ../../reliability.rst:256

source/adminguide/locale/pot/templates.pot

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ msgstr ""
341341

342342
#: ../../templates.rst:288
343343
# 942a09f060a248499ad52006fb12910b
344-
msgid "Linux templates should be prepared using this documentation in order to prepare your linux VMs for template deployment. For ease of documentation, the VM which you are configuring the template on will be referred to as \"Template Master\". This guide currently covers legacy setups which do not take advantage of UserData and cloud-init and assumes openssh-server is installed during installation."
344+
msgid "Linux templates should be prepared using this documentation in order to prepare your linux VMs for template deployment. For ease of documentation, the VM which you are configuring the template on will be referred to as \"Template Primary\". This guide currently covers legacy setups which do not take advantage of UserData and cloud-init and assumes openssh-server is installed during installation."
345345
msgstr ""
346346

347347
#: ../../templates.rst:295
@@ -417,7 +417,7 @@ msgstr ""
417417

418418
#: ../../templates.rst:341
419419
# f68b6e4efb764f92a1e56ad9ea54f90c
420-
msgid "The next steps updates the packages on the Template Master."
420+
msgid "The next steps updates the packages on the Template Primary."
421421
msgstr ""
422422

423423
#: ../../templates.rst:343
@@ -473,7 +473,7 @@ msgstr ""
473473

474474
#: ../../templates.rst:434
475475
# 1f68693847f1433bb6541b70f1abedd5
476-
msgid "The following steps should be run when you are ready to template your Template Master. If the Template Master is rebooted during these steps you will have to run all the steps again. At the end of this process the Template Master should be shutdown and the template created in order to create and deploy the final template."
476+
msgid "The following steps should be run when you are ready to template your Template Primary. If the Template Primary is rebooted during these steps you will have to run all the steps again. At the end of this process the Template Primary should be shutdown and the template created in order to create and deploy the final template."
477477
msgstr ""
478478

479479
#: ../../templates.rst:440
@@ -483,7 +483,7 @@ msgstr ""
483483

484484
#: ../../templates.rst:442
485485
# 7a1b5554792c4cb1aa676f8e73a843b8
486-
msgid "This step removes information unique to your Template Master such as network MAC addresses, lease files and CD block devices, the files are automatically generated on next boot."
486+
msgid "This step removes information unique to your Template Primary such as network MAC addresses, lease files and CD block devices, the files are automatically generated on next boot."
487487
msgstr ""
488488

489489
#: ../../templates.rst:460
@@ -503,7 +503,7 @@ msgstr ""
503503

504504
#: ../../templates.rst:472
505505
# af913fb8f91b484bb83ac0737e1b1d10
506-
msgid "It is good practice to remove old logs from the Template Master."
506+
msgid "It is good practice to remove old logs from the Template Primary."
507507
msgstr ""
508508

509509
#: ../../templates.rst:481
@@ -513,7 +513,7 @@ msgstr ""
513513

514514
#: ../../templates.rst:483
515515
# 5a2162138fca40088196712b5650f551
516-
msgid "In order for the Ubuntu DHCP script to function and the CentOS dhclient to set the VM hostname they both require the Template Master's hostname to be \"localhost\", run the following commands to change the hostname."
516+
msgid "In order for the Ubuntu DHCP script to function and the CentOS dhclient to set the VM hostname they both require the Template Primary's hostname to be \"localhost\", run the following commands to change the hostname."
517517
msgstr ""
518518

519519
#: ../../templates.rst:493
@@ -543,7 +543,7 @@ msgstr ""
543543

544544
#: ../../templates.rst:513
545545
# f92b1a930b3e4d859616309b9db518e1
546-
msgid "Your now ready to shutdown your Template Master and create a template!"
546+
msgid "Your now ready to shutdown your Template Primary and create a template!"
547547
msgstr ""
548548

549549
#: ../../templates.rst:520

0 commit comments

Comments
 (0)