Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 15 commits into
base: 4.20
Choose a base branch
from

Conversation

abh1sar
Copy link
Collaborator

@abh1sar abh1sar commented May 13, 2025

Description

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

ACL Lists

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

Before:
Screenshot 2025-05-13 at 2 01 19 PM
After:
Screenshot 2025-05-13 at 2 01 31 PM
Before:
Screenshot 2025-05-13 at 2 03 00 PM
After:
Screenshot 2025-05-13 at 2 03 11 PM

User data

  1. Following industry conventions, User data should be written as two words
  2. 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.
  3. User data should not be followed by "a"

Before:
Screenshot 2025-05-13 at 2 04 42 PM
After:
Screenshot 2025-05-13 at 2 05 04 PM
Before:
Screenshot 2025-05-13 at 2 06 55 PM
After:
Screenshot 2025-05-13 at 2 07 21 PM

Use Title Case in main menu and create new * buttons

List of all changes done:
TitleCase.txt

Before:
Screenshot 2025-05-13 at 2 09 37 PM
After:
Screenshot 2025-05-13 at 2 14 08 PM

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

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

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

Copy link

codecov bot commented May 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.15%. Comparing base (8f2735a) to head (f1b573b).
Report is 3 commits behind head on 4.20.

Additional details and impacted files
@@             Coverage Diff              @@
##               4.20   #10856      +/-   ##
============================================
- Coverage     16.15%   16.15%   -0.01%     
- Complexity    13273    13277       +4     
============================================
  Files          5657     5657              
  Lines        497898   497939      +41     
  Branches      60374    60386      +12     
============================================
+ Hits          80435    80441       +6     
- Misses       408505   408532      +27     
- Partials       8958     8966       +8     
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.

@DaanHoogland 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 abh1sar requested a review from sureshanaparti May 20, 2025 15:01
"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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

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

@sureshanaparti sureshanaparti May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@abh1sar abh1sar requested a review from sureshanaparti June 5, 2025 08:52
@sureshanaparti sureshanaparti added this to the 4.20.2 milestone Jun 5, 2025
@abh1sar
Copy link
Collaborator Author

abh1sar commented Jun 5, 2025

@blueorangutan ui

@blueorangutan
Copy link

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

@blueorangutan
Copy link

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

"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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@@ -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",
Copy link
Contributor

@sureshanaparti sureshanaparti Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

update other locale jsons wherever applicable

Copy link
Collaborator Author

@abh1sar abh1sar Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"label.affinity.groups": "Affinity groups",
"label.affinitygroup": "Affinity group",
"label.affinity.groups": "Affinity Groups",
"label.affinitygroup": "Affinity Group",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"label.backup.repository": "Backup Repository",
"label.backup.restore": "Restore Instance backup",
"label.backupofferingid": "Backup offering",
"label.backupofferingname": "Backup offering",
"label.backupofferingid": "Backup Offering",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@@ -996,7 +995,7 @@
"label.firewall": "Firewall",
"label.firewall.policy": "Firewall Policy",
"label.firewallpolicy": "Firewall Policy",
"label.firewallrule": "Firewall rule",
"label.firewallrule": "Firewall Rule",
"label.firewallruleuuid": "Firewall Rule",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"label.firewallruleuuid": "Firewall Rule",
"label.firewall.rule.uuid": "Firewall Rule",

"label.networkofferingdisplaytext": "Network offering",
"label.networkofferingid": "Network offering",
"label.networkofferingname": "Network offering",
"label.networkofferingdisplaytext": "Network Offering",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"label.networkofferingdisplaytext": "Network Offering",
"label.network.offering,displaytext": "Network Offering",

@@ -1524,9 +1523,9 @@
"label.networklimit": "Network limits",
"label.networkmode": "Network Mode",
"label.networkname": "Network name",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

network.* ?

"label.networkofferingname": "Network offering",
"label.networkofferingdisplaytext": "Network Offering",
"label.networkofferingid": "Network Offering",
"label.networkofferingname": "Network Offering",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

network.offering.*

@@ -1605,7 +1604,7 @@
"label.of.month": "of month",
"label.offerha": "Offer HA",
"label.offeringid": "Offering ID",
"label.offeringtype": "Compute offering type",
"label.offeringtype": "Compute Offering type",
Copy link
Contributor

@sureshanaparti sureshanaparti Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

offering.id & offering.type ?

"label.primary.storage.allocated": "Primary Storage allocated",
"label.primary.storage.used": "Primary Storage used",
"label.primarystoragelimit": "Primary Storage limits (GiB)",
"label.primarystoragetotal": "Primary Storage",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

primary.storage.*

"label.removed": "Removed",
"label.removing": "Removing",
"label.replace.acl": "Replace ACL",
"label.replace.acl.list": "Replace ACL list",
"label.replace.acl.list": "Replace ACL",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"label.secondaryips": "Secondary IPs",
"label.secondarystoragelimit": "Secondary storage limits (GiB)",
"label.secondarystoragelimit": "Secondary Storage limits (GiB)",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

secondary.storage.*

"label.serviceofferingid": "Compute offering",
"label.serviceofferingname": "Compute offering",
"label.serviceofferingid": "Compute Offering",
"label.serviceofferingname": "Compute Offering",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

service.offering.*

"label.storage.traffic": "Storage traffic",
"label.storageid": "Primary storage",
"label.storageid": "Primary Storage",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"label.storageid": "Primary Storage",
"label.storage.id": "Primary Storage",

"label.vpcoffering": "VPC offering",
"label.vpcofferingid": "VPC offering",
"label.vpcoffering": "VPC Offering",
"label.vpcofferingid": "VPC Offering",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"label.vpcofferingid": "VPC Offering",
"label.vpc.offering.id": "VPC Offering",

"label.vpc.virtual.router": "VPC virtual router",
"label.vpc.restart.required": "VPC restart required",
"label.vpcid": "VPC",
"label.vpclimit": "VPC limits",
"label.vpcname": "VPC",
"label.vpcoffering": "VPC offering",
"label.vpcofferingid": "VPC offering",
"label.vpcoffering": "VPC Offering",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"label.vpcoffering": "VPC Offering",
"label.vpc.offering": "VPC Offering",

Copy link

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@abh1sar
Copy link
Collaborator Author

abh1sar commented Jun 18, 2025

@sureshanaparti to keep the scope of this PR manageable, I'll create a new PR later to handle all suggested label changes.

@abh1sar
Copy link
Collaborator Author

abh1sar commented Jun 18, 2025

@blueorangutan ui

@abh1sar abh1sar requested a review from sureshanaparti June 18, 2025 13:56
@sureshanaparti
Copy link
Contributor

@blueorangutan ui

@blueorangutan
Copy link

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

@blueorangutan
Copy link

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

@sureshanaparti
Copy link
Contributor

@blueorangutan package

@blueorangutan
Copy link

@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
Copy link

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

Copy link
Contributor

@sureshanaparti sureshanaparti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants