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

Add network storage: Comment text for the name misleading #23693

Open
4 tasks done
Zentris opened this issue Jan 11, 2025 · 12 comments
Open
4 tasks done

Add network storage: Comment text for the name misleading #23693

Zentris opened this issue Jan 11, 2025 · 12 comments

Comments

@Zentris
Copy link

Zentris commented Jan 11, 2025

Checklist

  • I have updated to the latest available Home Assistant version.
  • I have cleared the cache of my browser.
  • I have tried a different browser to see if it is related to my browser.
  • I have tried reproducing the issue in safe mode to rule out problems with unsupported custom resources.

Describe the issue you are experiencing

If you want to add a new network storage, you will have to enter the name at the top.

The comment text for the name is misleading in the German translation in that it states that this name becomes part of the storage path on the network drive.

Backup_Name_German_Missleading_Komment

However, this is not the case: The original English text clearly states that the name is “only” descriptive.

Please correct, but I can only check this for the German language.

(I didn't even find the translations in the code... wanted to try a correction/patch myself :-) )

Describe the behavior you expected

The text should indicate that the name is only really the name of the network storage and has no influence on the path of the network drive.

In example (ger):
"Dieser Name wird dir in der Benutzeroberfläche angezeigt als Bezeichnung für diesen Netzwerkspeicher"

Steps to reproduce the issue

I write the steps here in english, normally i see the GUI in german ;-)

  1. Configuration => System => Storage => Network starage => "Add new network storage"

  2. A Sub-Window opens and it is the first line in top of the window...

What version of Home Assistant Core has the issue?

2025.1.2

What was the last working version of Home Assistant Core?

2025.1.2

In which browser are you experiencing the issue?

Google Chrome 131.0.6778.264

Which operating system are you using to run this browser?

Ubuntu 24.04-LTS

State of relevant entities

No response

Problem-relevant frontend configuration

No response

Javascript errors shown in your browser console/inspector

No response

Additional information

No response

@Zentris
Copy link
Author

Zentris commented Jan 11, 2025

Supplement:

The storage to be used should be a NAS network storage via NFS...

@karwosts
Copy link
Contributor

Please see here to make a correction:
https://developers.home-assistant.io/docs/translations/

@Zentris
Copy link
Author

Zentris commented Jan 12, 2025

@karwosts:
Thanks for the tip, I have already logged in there and found the text..., BUT:

I don't currently know where else this string is used, as I'm not familiar with the source code.

I would like to avoid a situation where my change in a different place might result in a wrong reference being made there and then causing new work.

Or in other words/questions: How can I find out where in the code the texts are referenced?

@silamon
Copy link
Contributor

silamon commented Jan 12, 2025

The frontend repository only contains the English translations. Other translations, including German translations, are added when the release is built. So, the easiest way to find it, is to switch to English then do a find in the repository to find the key.

This is the (only) used place:

`ui.panel.config.storage.network_mounts.options.${schema.name}.title`

cc @NoRi2909

@NoRi2909
Copy link
Contributor

@silamon Thanks for cc'ing me.

@Zentris The English text here (ui::panel::config::storage::network_mounts::options::name::description) is:

"This name will be shown to you in the UI, and will also be the name of the folder created on your system"

That does not sound to me as the name being just descriptive but rather the name of the mount?

So as I read this the current German translation does match this, so if that is not correct we might want to clarify the English text here so it better reflects what this name is and where it will be used.

@Plobli
Copy link

Plobli commented Jan 12, 2025

Describe the behavior you expected

The text should indicate that the name is only really the name of the network storage and has no influence on the path of the network drive.

In example (ger):
"Dieser Name wird dir in der Benutzeroberfläche angezeigt als Bezeichnung für diesen Netzwerkspeicher"

This is not correct. The name is not only displayed in the user interface as the name for this network storage device. A folder with this name is also created on the Home Assistant system. This folder is the mount point for mounting the network drive.

@NoRi2909
Copy link
Contributor

@Zentris As you have looked up the German string in Lokalise you have also seen the English string next to it:

image

I did not author the translation, but I'd probably use the exact same wording, too.

So the problem you are reporting is that you read

  • "This name … will also be the name of the folder created on your system"

as (quoting your bug report above):

  • "This name … becomes part of the storage path on the network drive."

This technically makes no sense, you cannot alter the storage path on a network drive by mounting a network share, you will only create a local mount point folder on your system - i.e. Home Assistant.

Let us know how rewording the English text would avoid this misunderstanding, then we will automatically do the same in German.

@Zentris
Copy link
Author

Zentris commented Jan 12, 2025

Thank you for your active participation in my report.

A brief word about my background: I was a software tester at Siemens for about 20 years in mobile phone development and often had to deal with the problem that we technicians formulate something that the normal user does not understand or understands differently....

It is the implication that arises from the help text:

The way it (English/German) says it, the user will conclude (as I did) that HA will (automatically) create a subfolder with the specified name as a subfolder under the (mounted) network drive.

What happens in HA itself, i.e. that a directory with the name is created under the mount, is primarily of no interest to the user...

I was surprised that the subdirectory was NOT created on the NAS. Because I know other systems (e.g. Proxmox does it similarly) that have a similar syntax: Specify the server, specify the mount path to the NAS and then either a subfolder name or the assigned identifier is (automatically) created from the name of the entry itself (Or as with Proxmox, the directories are automatically created according to system-internal rule if not present).

The current help text shows the technical view of the processes within HA.

I suggest either adapting the text as suggested above or adapting the behavior of HA to the current text (i.e. automatic creation of the subdirectory (specified name) on the network drive). With the latter, the user has a coherent view HA <=> network drive.

@NoRi2909
Copy link
Contributor

OK, then we agree that this bug report is not related to the German translation and you can drop "in German" from the title of this report.

As I understand it you equate "your system" with "your NAS system" which is not what the text means. The folder is created on the system that hosts Home Assistant.

If the English text swapped "your system" with "your Home Assistant instance" this should avoid that misunderstanding completely:

"This name … will also be the name of the folder created on your Home Assistant instance"

@Zentris Zentris changed the title Add network storage: Comment text for the name misleading in German Add network storage: Comment text for the name misleading Jan 12, 2025
@Zentris
Copy link
Author

Zentris commented Jan 12, 2025

Ok, I've removed “German” from the report headline, I'm with you on the content.

And yes, if the help text is adapted in this way, irritation would be reduced as I described.

I think this would minimize the amount of correction work.

Addition

Yes, of course: “My system” is the HA.instance. My NAS (i.e. the network drive) is a remote system...

Both have different directory structures. As a user, I am interested in the structure on my NAS and not how I can connect it to HA (i.e. the internal mount point in the HA instance)

@NoRi2909
Copy link
Contributor

Thanks for the title change. Then I'm out for now and others need to pick up on the suggested rewording for the English strings.

@Plobli
Copy link

Plobli commented Jan 12, 2025

Then I also think that the description: “This name will be displayed in the user interface as the designation for this network storage.” is good and meaningful.

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

No branches or pull requests

5 participants