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
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>
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.
104
104
105
105
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.
106
106
@@ -115,40 +115,40 @@ It is good practice to create a new branch each time you want to contribute to t
115
115
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`.
116
116
117
117
118
-
Merging `upstream/master` into your `dev` branch
118
+
Merging `upstream/main` into your `dev` branch
119
119
------------------------------------------------
120
120
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.
122
122
123
123
This process will do the following:
124
124
125
-
#. Checkout your local `master` branch
125
+
#. Checkout your local `main` branch
126
126
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
128
128
129
129
#. Merge the latest changes from the official docs into your `dev` branch so it is up-to-date with the latest changes
130
130
131
131
.. code:: bash
132
132
133
-
$ git checkout master
133
+
$ git checkout main
134
134
$ git fetch upstream
135
-
$ git merge upstream/master
135
+
$ git merge upstream/main
136
136
$ git checkout dev
137
-
$ git pull .master
137
+
$ git pull .main
138
138
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`.
140
140
141
141
142
142
Making a pull request on GitHub to contribute your changes
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.
146
146
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.
148
148
149
149
.. code:: bash
150
150
151
-
$ git push origin master
151
+
$ git push origin main
152
152
$ git push origin dev
153
153
154
154
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
167
167
Cleaning up after a successful pull request
168
168
-------------------------------------------
169
169
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.
171
171
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!
173
173
174
174
You can delete these deprecated branches with the following:
Copy file name to clipboardExpand all lines: source/adminguide/locale/pot/networking.pot
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -730,7 +730,7 @@ msgstr ""
730
730
731
731
#:../../networking.rst:369
732
732
# 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."
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."
Copy file name to clipboardExpand all lines: source/adminguide/locale/pot/networking2.pot
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -5988,12 +5988,12 @@ msgstr ""
5988
5988
5989
5989
#:../../networking2.rst:5737
5990
5990
# 4bb61ba3dd1444269d2f517a3d774dac
5991
-
msgid"Blacklisting Routes"
5991
+
msgid"Denylisting Routes"
5992
5992
msgstr""
5993
5993
5994
5994
#:../../networking2.rst:5739
5995
5995
# 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."
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."
Copy file name to clipboardExpand all lines: source/adminguide/locale/pot/reliability.pot
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -283,22 +283,22 @@ msgstr ""
283
283
284
284
#:../../reliability.rst:207
285
285
# 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."
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."
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."
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."
Copy file name to clipboardExpand all lines: source/adminguide/locale/pot/templates.pot
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -341,7 +341,7 @@ msgstr ""
341
341
342
342
#:../../templates.rst:288
343
343
# 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."
345
345
msgstr""
346
346
347
347
#:../../templates.rst:295
@@ -417,7 +417,7 @@ msgstr ""
417
417
418
418
#:../../templates.rst:341
419
419
# 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."
421
421
msgstr""
422
422
423
423
#:../../templates.rst:343
@@ -473,7 +473,7 @@ msgstr ""
473
473
474
474
#:../../templates.rst:434
475
475
# 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."
477
477
msgstr""
478
478
479
479
#:../../templates.rst:440
@@ -483,7 +483,7 @@ msgstr ""
483
483
484
484
#:../../templates.rst:442
485
485
# 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."
487
487
msgstr""
488
488
489
489
#:../../templates.rst:460
@@ -503,7 +503,7 @@ msgstr ""
503
503
504
504
#:../../templates.rst:472
505
505
# 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."
507
507
msgstr""
508
508
509
509
#:../../templates.rst:481
@@ -513,7 +513,7 @@ msgstr ""
513
513
514
514
#:../../templates.rst:483
515
515
# 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."
517
517
msgstr""
518
518
519
519
#:../../templates.rst:493
@@ -543,7 +543,7 @@ msgstr ""
543
543
544
544
#:../../templates.rst:513
545
545
# 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!"
0 commit comments