Skip to content
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

Replace dash "-" with "/" in metadata #374

Merged
merged 2 commits into from
Nov 20, 2024

Conversation

newzealandpaul
Copy link
Contributor

@newzealandpaul newzealandpaul commented Nov 19, 2024

Note

We are meticulous when it comes to merging code into the main branch, so please understand that we may reject pull requests that do not meet the project's standards. It's never personal. Also, game-related scripts have a lower chance of being merged.

Description

Categories currently use the dash "-" symbol to represent shorthand "and" in category names in the metadata.

This is contra to normal English language usage and informal web usage where "-" is usually used to denote a category, or sub-category.

In informal english language "/" usually means logical "or" (a set encompassing all of A, all of B including all of A and B).

I also think it looks better.

Matter/Zigbee/Zwave was renamed to continue to make sense.

I have some further taxonomical changes I want to suggest but this needs to be first to avoid conflicting PR.

Screenshot:

Screenshot 2024-11-20 at 11 53 20 AM

You can have a look at a demo of it here (Edit: I use my main branch for testing so might not always be the demo):

https://newzealandpaul.github.io/ProxmoxVE/scripts

Type of change

Please check the relevant option(s):

  • Bug fix (non-breaking change that resolves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (a fix or feature that would cause existing functionality to change unexpectedly)
  • New script (a fully functional and thoroughly tested script or set of scripts.)

Prerequisites

The following efforts must be made for the PR to be considered. Please check when completed:

  • Self-review performed (I have reviewed my code, ensuring it follows established patterns and conventions)
  • Testing performed (I have tested my changes, ensuring everything works as expected)
  • Documentation updated (I have updated any relevant documentation)

Additional Information (optional)

I also tried "&" symbol and it didn't look as nice.

Screenshot 2024-11-20 at 11 39 14 AM

@github-actions github-actions bot added the website A change to the website label Nov 19, 2024
@newzealandpaul newzealandpaul marked this pull request as ready for review November 19, 2024 22:52
@newzealandpaul newzealandpaul requested a review from a team as a code owner November 19, 2024 22:52
MickLesk
MickLesk previously approved these changes Nov 19, 2024
@BramSuurdje
Copy link
Collaborator

i actually really like the "&" symbol, can we get some more opinions on this? i do agree that it at least needs to be change from "-"

@newzealandpaul
Copy link
Contributor Author

i actually really like the "&" symbol, can we get some more opinions on this? i do agree that it at least needs to be change from "-"

If the & symbol was used, which was my first try, then "Matter / Zigbee / ZWave" can stay the same other than including spaces.

@BramSuurdje
Copy link
Collaborator

Yeah, that seems like the best option in my opinion. I prefer using ‘&’ because it reads better, its like saying ‘Pi-hole and DNS’ instead of ‘Pi-hole … DNS’ but i.g its all personal preference

so keep Matter / Zigbee / ZWave the same and change the others to &?

thats my proposal

havardthom
havardthom previously approved these changes Nov 20, 2024
Copy link
Contributor

@havardthom havardthom left a comment

Choose a reason for hiding this comment

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

Both works for me

@newzealandpaul newzealandpaul dismissed stale reviews from havardthom and MickLesk via c983cbe November 20, 2024 07:21
@newzealandpaul
Copy link
Contributor Author

Ok folks, & it is :) This change just needs reapproval please @havardthom @MickLesk . Can be viewed here:

https://newzealandpaul.github.io/ProxmoxVE/scripts

I went with "Matter, Zigbee & ZWave" as I just think this makes more sense and reads like how someone would describe the category "Matter, Zigbee and ZWave". For another discussion but I personally would rename this "Home Automation" but thats a discussion for another day.

Copy link
Member

@MickLesk MickLesk left a comment

Choose a reason for hiding this comment

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

Fine for me

@MickLesk MickLesk merged commit 058f032 into community-scripts:main Nov 20, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website A change to the website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants