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

abh1sar · 2025-05-13T11:25:54Z

Description

This PR fixes some inconsistencies in object names and messages.
doc pr : apache/cloudstack-documentation#506

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

Before:

After:

Before:

After:

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"

Before:

After:

Before:

After:

Use Title Case in main menu and create new * buttons

List of all changes done:
TitleCase.md

Before:

After:

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

…blic/locales

…ue and AclRulesTab.vue

…ister user data form.

codecov · 2025-05-13T11:34:07Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.15%. Comparing base (8f2735a) to head (87c0a24).
Report is 33 commits behind head on 4.20.

Additional details and impacted files

@@            Coverage Diff            @@
##               4.20   #10856   +/-   ##
=========================================
  Coverage     16.15%   16.15%           
- Complexity    13273    13274    +1     
=========================================
  Files          5657     5656    -1     
  Lines        497898   497813   -85     
  Branches      60374    60373    -1     
=========================================
  Hits          80435    80435           
+ Misses       408505   408425   -80     
+ Partials       8958     8953    -5

Flag	Coverage Δ
uitests	`4.00% <ø> (+<0.01%)`	⬆️
unittests	`17.00% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sureshanaparti · 2025-05-23T15:56:13Z

ui/public/locales/en.json

-"label.add.intermediate.certificate": "Add intermediate certificate",
+"label.add.host": "Add Host",
+"label.add.ingress.rule": "Add Ingress rule",
+"label.add.intermediate.certifrcate": "Add intermediate certificate",


Suggested change

"label.add.intermediate.certifrcate": "Add intermediate certificate",

"label.add.intermediate.certificate": "Add intermediate certificate",

sureshanaparti · 2025-05-23T15:58:40Z

ui/public/locales/en.json

+"label.userdataname": "User data name",
+"label.userdatadetails": "User data details",
+"label.userdataparams": "User data parameters",
+"label.userdatapolicy": "User data link policy",


update label keys as well -label.user.data.id|name|details|...

abh1sar · 2025-06-05T10:01:32Z

@blueorangutan ui

blueorangutan · 2025-06-05T10:02:03Z

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

blueorangutan · 2025-06-05T10:19:57Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/10856 (QA-JID-639)

sureshanaparti · 2025-06-09T12:02:00Z

api/src/main/java/org/apache/cloudstack/api/command/user/userdata/RegisterUserDataCmd.java

-                    "Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. " +
-                    "You also need to change vm.userdata.max.length value",
+                    "Using HTTP POST (via POST body), you can send up to 32KB of data after base64 encoding, " +
+                    "which can be increased upto 1MB using the vm.userdata.max.length setting",


should we change setting 'vm.userdata.max.length' => 'vm.user.data.max.length' as well?

I think we should avoid changing the name of any setting in case anyone is already using it.

sureshanaparti · 2025-06-09T12:03:47Z

ui/public/locales/ar.json

@@ -924,7 +924,7 @@
 "label.remove.vpc.offering": "Remove VPC offering",
 "label.removing": "Removing",
 "label.replace.acl": "Replace ACL",
-"label.replace.acl.list": "Replace ACL List",
+"label.replace.acl.list": "Replace ACL",


Suggested change

"label.replace.acl.list": "Replace ACL",

"label.replace.acl": "Replace ACL",

update other locale jsons wherever applicable

replaced label.replace.acl.list with label.replace.acl at all usages and removed the label.

ui/public/locales/ca.json

sureshanaparti · 2025-06-09T12:10:01Z

ui/public/locales/en.json

-"label.affinity.groups": "Affinity groups",
-"label.affinitygroup": "Affinity group",
+"label.affinity.groups": "Affinity Groups",
+"label.affinitygroup": "Affinity Group",


Suggested change

"label.affinitygroup": "Affinity Group",

"label.affinity.group": "Affinity Group",

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

ui/public/locales/en.json

 "label.backup.repository": "Backup Repository",
 "label.backup.restore": "Restore Instance backup",
-"label.backupofferingid": "Backup offering",
-"label.backupofferingname": "Backup offering",
+"label.backupofferingid": "Backup Offering",


Suggested change

"label.backupofferingid": "Backup Offering",

"label.backup.offering.id": "Backup Offering",

abh1sar · 2025-07-08T09:53:05Z

@blueorangutan package

blueorangutan · 2025-07-08T09:54:04Z

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

abh1sar · 2025-07-08T10:17:40Z

I'll handle @sureshanaparti comments on generic label name changes on a different PR.

blueorangutan · 2025-07-08T12:01:59Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✖️ debian ✔️ suse15. SL-JID 14091

abh1sar · 2025-07-10T07:57:26Z

@blueorangutan ui

blueorangutan · 2025-07-10T07:58:03Z

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

blueorangutan · 2025-07-10T08:15:27Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/10856 (QA-JID-662)

…nto ui-polish

abh1sar · 2025-07-17T03:45:29Z

@blueorangutan package

blueorangutan · 2025-07-17T03:46:03Z

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-07-17T05:27:56Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14222

abh1sar · 2025-07-23T11:24:06Z

@blueorangutan ui

blueorangutan · 2025-07-23T11:25:04Z

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

blueorangutan · 2025-07-23T11:42:06Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/10856 (QA-JID-680)

sureshanaparti · 2025-07-23T11:48:07Z

@blueorangutan package

blueorangutan · 2025-07-23T11:50:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-07-23T13:14:10Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14314

sureshanaparti · 2025-07-23T13:43:54Z

@blueorangutan test

blueorangutan · 2025-07-23T13:46:04Z

@sureshanaparti a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

rosi-shapeblue

LGTM

blueorangutan · 2025-07-24T05:38:00Z

[SF] Trillian test result (tid-13860)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 54239 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10856-t13860-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

abh1sar added 10 commits April 30, 2025 15:50

Replace ACL list with ACL and related changes to the json files in pu…

4334097

…blic/locales

Replace ACL list with ACL and related changes to network.js, VpcTab.v…

afab814

…ue and AclRulesTab.vue

Replace Export ACLs with Export ACL rules

41eee1f

standardize the term user data everywhere. fix the placeholder in reg…

0519d76

…ister user data form.

Convert resource names in main menu and action buttons to Title case

6c987c8

Use special icon for sharedfs instance and prefix for sharedfs volumes

8252d53

Give custom icon precedence over shared fs icon

64462e8

Merge remote-tracking branch 'upstream/4.20' into ui-polish

d980cd0

Fixed some issues with public/locale files

ff30b6f

Revert sharedfsvm changes

a75802a

boring-cyborg bot added component:api component:UI labels May 13, 2025

Added label.add.acl.name to en.json which was incorrectly removed

c55630f

DaanHoogland changed the title ~~Polish: Fix some inconsistencies in object names and messages~~ polish: Fix some inconsistencies in object names and messages May 13, 2025

abh1sar mentioned this pull request May 19, 2025

polish: Fix some inconsistencies in object names and messages apache/cloudstack-documentation#506

Merged

abh1sar requested a review from sureshanaparti May 20, 2025 15:01

sureshanaparti reviewed May 23, 2025

View reviewed changes

replace all *userdata* labels to *user.data* in public json files.

285b64c

abh1sar requested a review from sureshanaparti June 5, 2025 08:52

sureshanaparti added this to the 4.20.2 milestone Jun 5, 2025

sureshanaparti reviewed Jun 9, 2025

View reviewed changes

ui/public/locales/ca.json Outdated Show resolved Hide resolved

sureshanaparti reviewed Jun 9, 2025

View reviewed changes

abh1sar added 2 commits July 17, 2025 08:52

user data -> User Data in cmd and response

d58bb99

Merge branch 'ui-polish' of https://github.com/shapeblue/cloudstack i…

b52fccd

…nto ui-polish

sureshanaparti requested review from DaanHoogland and rosi-shapeblue July 22, 2025 13:58

fix more Title case on action buttons and labels.

87c0a24

rosi-shapeblue approved these changes Jul 23, 2025

View reviewed changes

sureshanaparti added the status:waiting-for-smoketest-results label Jul 23, 2025

abh1sar marked this pull request as ready for review July 24, 2025 07:25

sureshanaparti removed the status:waiting-for-smoketest-results label Jul 24, 2025

sureshanaparti merged commit eeb4d55 into apache:4.20 Jul 24, 2025
26 checks passed

abh1sar deleted the ui-polish branch July 24, 2025 17:10

	"label.add.intermediate.certifrcate": "Add intermediate certificate",
	"label.add.intermediate.certificate": "Add intermediate certificate",

	"label.replace.acl.list": "Replace ACL",
	"label.replace.acl": "Replace ACL",

	"label.affinitygroup": "Affinity Group",
	"label.affinity.group": "Affinity Group",

	"label.backupofferingid": "Backup Offering",
	"label.backup.offering.id": "Backup Offering",

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

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

Conversation

abh1sar commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

ACL Lists

User data

Use Title Case in main menu and create new * buttons

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sureshanaparti May 23, 2025

Choose a reason for hiding this comment

Uh oh!

abh1sar Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

sureshanaparti May 23, 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!

abh1sar Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

abh1sar commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

sureshanaparti Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

abh1sar Jun 18, 2025

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!

abh1sar Jun 18, 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!

Uh oh!

sureshanaparti Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

abh1sar commented Jul 8, 2025

Uh oh!

blueorangutan commented Jul 8, 2025

Uh oh!

abh1sar commented Jul 8, 2025

Uh oh!

blueorangutan commented Jul 8, 2025

Uh oh!

abh1sar commented Jul 10, 2025

Uh oh!

blueorangutan commented Jul 10, 2025

Uh oh!

blueorangutan commented Jul 10, 2025

Uh oh!

abh1sar commented Jul 17, 2025

Uh oh!

blueorangutan commented Jul 17, 2025

Uh oh!

blueorangutan commented Jul 17, 2025

abh1sar commented May 13, 2025 •

edited

Loading

codecov bot commented May 13, 2025 •

edited

Loading

sureshanaparti May 23, 2025 •

edited

Loading

sureshanaparti Jun 9, 2025 •

edited

Loading

abh1sar Jun 18, 2025 •

edited

Loading