polish: Fix some inconsistencies in object names and messages by abh1sar · Pull Request #506 · apache/cloudstack-documentation

abh1sar · 2025-05-19T00:59:18Z

Documentation PR for apache/cloudstack#10856

ACL Lists

Replace ACL Lists with ACLs as Access Control List Lists doesn't make sense
Replace Add ACL with Add ACL rule wherever a rule is being added

User data

Following industry conventions, User data should be written as two words
The term "User Data" used in the main menu creates some confusion, whether it is singular or plural. So renamed it to "User Data Library" where users can register new User Data.
User data should not be followed by "a"

📚 Documentation preview 📚: https://cloudstack-documentation--506.org.readthedocs.build/en/506/

DaanHoogland

general remark; user data, User data and User Data seem to be used interchangably. maybe cleanup?
also I suggest a global replace of "ACL rule" with "access rule"

DaanHoogland · 2025-06-03T13:46:56Z

source/adminguide/networking/virtual_private_cloud_config.rst

+About Network ACLs
 ^^^^^^^^^^^^^^^^^^^^^^^


Suggested change

About Network ACLs

^^^^^^^^^^^^^^^^^^^^^^^

About Network ACLs

^^^^^^^^^^^^^^^^^^

DaanHoogland · 2025-06-03T13:47:50Z

source/adminguide/networking/virtual_private_cloud_config.rst

+Creating ACLs
 ^^^^^^^^^^^^^^^^^^


Suggested change

Creating ACLs

^^^^^^^^^^^^^^^^^^

Creating ACLs

^^^^^^^^^^^^^

DaanHoogland · 2025-06-03T13:48:19Z

source/adminguide/networking/virtual_private_cloud_config.rst

+Creating a Tier with Custom ACL
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Suggested change

Creating a Tier with Custom ACL

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Creating a Tier with Custom ACL

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

DaanHoogland · 2025-06-03T13:48:51Z

source/adminguide/networking/virtual_private_cloud_config.rst

+Assigning a Custom ACL to a Tier
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Suggested change

Assigning a Custom ACL to a Tier

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Assigning a Custom ACL to a Tier

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

DaanHoogland · 2025-06-03T13:49:23Z

source/adminguide/virtual_machines/user-data.rst

+Storing and accessing user data
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Suggested change

Storing and accessing user data

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Storing and accessing user data

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

DaanHoogland · 2025-06-03T13:50:46Z

source/plugins/ipv6.rst

   :alt: Add IPv6 ACL rule.
 .. |ipv6-acl-list.png| image:: /_static/images/ipv6-acl-list.png
-   :alt: IPv6 ACL rule in Network ACL list.
+   :alt: IPv6 ACL rule in Network ACL.


Suggested change

:alt: IPv6 ACL rule in Network ACL.

:alt: IPv6 access rule in Network ACL.

??

abh1sar · 2025-06-06T04:58:36Z

@blueorangutan docbuild

blueorangutan · 2025-06-06T04:59:03Z

@abh1sar a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.

blueorangutan · 2025-06-06T05:00:04Z

QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/506. (QA-JID 358)

abh1sar · 2025-06-06T05:07:59Z

general remark; user data, User data and User Data seem to be used interchangably. maybe cleanup? also I suggest a global replace of "ACL rule" with "access rule"

Thanks for the review @DaanHoogland
I have cleaned up user data (there were also many instances where 'user-data' was being used. Have replaced it with 'user data'). Also, I had missed updating the screenshots earlier.

I’m not entirely convinced about using “access rule”. It feels like a more generic term and might be unclear without proper context. Other platforms, like AWS, use the term “ACL rules,” so I’d prefer to stick with that for clarity and consistency.
https://docs.aws.amazon.com/vpc/latest/userguide/nacl-rules.html

sureshanaparti · 2025-06-09T12:29:45Z

source/adminguide/networking/dynamic_static_routing.rst


 - NATTED. This is the default network mode of isolated networks. The VR of isolated networks and VPCs provides Source NAT services, as well as Static NAT, Load Balancer, Port Forwarding, Vpn if the network offering supports.
- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and Vpn. The supported services are Dns, Dhcp, Userdata, Firewall (for isolated networks) and Network ACL (for vpc and vpc networks).
+- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and Vpn. The supported services are Dns, Dhcp, User data, Firewall (for isolated networks) and Network ACL (for vpc and vpc networks).


Suggested change

- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and Vpn. The supported services are Dns, Dhcp, User data, Firewall (for isolated networks) and Network ACL (for vpc and vpc networks).

- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and VPN. The supported services are DNS, DHCP, User data, Firewall (for isolated networks) and Network ACL (for VPC and VPC networks).

sureshanaparti · 2025-06-09T12:30:05Z

source/adminguide/networking/dynamic_static_routing.rst

@@ -41,7 +41,7 @@ Network mode indicates the mode with which the isolated network or VPC will oper
 There are two valid options

 - NATTED. This is the default network mode of isolated networks. The VR of isolated networks and VPCs provides Source NAT services, as well as Static NAT, Load Balancer, Port Forwarding, Vpn if the network offering supports.


Suggested change

- NATTED. This is the default network mode of isolated networks. The VR of isolated networks and VPCs provides Source NAT services, as well as Static NAT, Load Balancer, Port Forwarding, Vpn if the network offering supports.

- NATTED. This is the default network mode of isolated networks. The VR of isolated networks and VPCs provides Source NAT services, as well as Static NAT, Load Balancer, Port Forwarding, VPN if the network offering supports.

sureshanaparti · 2025-06-09T12:31:20Z

source/conceptsandterminology/network_setup.rst

 1:1 NAT                    Physical                             Physical and Virtual
 Source NAT                 No                                   Physical and Virtual
-Userdata                   Yes                                  Yes
+User data                  Yes                                 Yes


Suggested change

User data Yes Yes

User data Yes Yes

check column alignment with other columns text.

abh1sar · 2025-06-18T08:05:15Z

@blueorangutan docbuild

blueorangutan · 2025-06-18T08:06:05Z

@abh1sar a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.

blueorangutan · 2025-06-18T08:07:11Z

QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/506. (QA-JID 371)

abh1sar · 2025-07-28T13:04:59Z

@blueorangutan docbuild

blueorangutan · 2025-07-28T13:06:07Z

@abh1sar a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress.

blueorangutan · 2025-07-28T13:07:09Z

QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/506. (QA-JID 399)

RosiKyu

LGTM. The documentation has been updated in accordance with the scope defined in the FR.

abh1sar added 2 commits May 13, 2025 19:26

Replace ACL List with ACL

0ac80e9

Replace Userdata with User data

f611702

abh1sar mentioned this pull request May 19, 2025

polish: Fix some inconsistencies in object names and messages apache/cloudstack#10856

Merged

14 tasks

DaanHoogland reviewed Jun 3, 2025

View reviewed changes

Addressed review comments and updated screenshots

3c9f863

sureshanaparti reviewed Jun 9, 2025

View reviewed changes

minor changes

e1e0532

sureshanaparti approved these changes Jun 25, 2025

View reviewed changes

sureshanaparti added this to the 4.20.2 milestone Jul 21, 2025

sureshanaparti requested a review from DaanHoogland July 24, 2025 04:19

User Data should be in title case

94d1188

abh1sar marked this pull request as ready for review July 28, 2025 13:04

RosiKyu approved these changes Jul 28, 2025

View reviewed changes

sureshanaparti merged commit f285c3f into apache:4.20 Jul 28, 2025
1 check passed

		Creating a Tier with Custom ACL
		^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

		Assigning a Custom ACL to a Tier
		^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

		Storing and accessing user data
		~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

	:alt: IPv6 ACL rule in Network ACL.
	:alt: IPv6 access rule in Network ACL.

	- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and Vpn. The supported services are Dns, Dhcp, User data, Firewall (for isolated networks) and Network ACL (for vpc and vpc networks).
	- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and VPN. The supported services are DNS, DHCP, User data, Firewall (for isolated networks) and Network ACL (for VPC and VPC networks).

		@@ -41,7 +41,7 @@ Network mode indicates the mode with which the isolated network or VPC will oper
		There are two valid options

		- NATTED. This is the default network mode of isolated networks. The VR of isolated networks and VPCs provides Source NAT services, as well as Static NAT, Load Balancer, Port Forwarding, Vpn if the network offering supports.

Conversation

abh1sar commented May 19, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ACL Lists

User data

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abh1sar commented Jun 6, 2025

Uh oh!

blueorangutan commented Jun 6, 2025

Uh oh!

blueorangutan commented Jun 6, 2025

Uh oh!

abh1sar commented Jun 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abh1sar commented Jun 18, 2025

Uh oh!

blueorangutan commented Jun 18, 2025

Uh oh!

blueorangutan commented Jun 18, 2025

Uh oh!

abh1sar commented Jul 28, 2025

Uh oh!

blueorangutan commented Jul 28, 2025

Uh oh!

blueorangutan commented Jul 28, 2025

Uh oh!

RosiKyu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

abh1sar commented May 19, 2025 •

edited by github-actions bot

Loading

sureshanaparti Jun 9, 2025 •

edited

Loading