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

Standardize 'Show' labels to manifest fields #2311

Merged
merged 3 commits into from
Jul 29, 2022

Conversation

Trenly
Copy link
Contributor

@Trenly Trenly commented Jul 6, 2022


Microsoft Reviewers: Open in CodeFlow

@Trenly Trenly requested a review from a team as a code owner July 6, 2022 22:40
@ghost ghost added Area-Output Issue related to CLI output Issue-Feature This is a feature request for the Windows Package Manager client. labels Jul 6, 2022
@denelon
Copy link
Contributor

denelon commented Jul 6, 2022

@Trenly

We had a discussion internally a while back related to the labels. Part of the reason we were exposing the exact "YAML" key values is because we weren't localizing the titles. I'm not sure how well this plays from a localization perspective.

Thoughts?

@Trenly
Copy link
Contributor Author

Trenly commented Jul 6, 2022

@Trenly

We had a discussion internally a while back related to the labels. Part of the reason we were exposing the exact "YAML" key values is because we weren't localizing the titles. I'm not sure how well this plays from a localization perspective.

Thoughts?

Hmmm. I'm not sure either. I think from a contributor perspective, I would rather see exact YAML keys (spaces added) as it provides simpler correlation between fields. From a user perspective, I would want the fields to be localized so I could understand what each of them were.

However, I would say that there is a fairly clear link between the Yaml keys and the meaning of the key. From an english-First perspective, I don't see any reason not to update the keys. From a localized perspective, I can see how it could make the localization more difficult to understand.

@denelon
Copy link
Contributor

denelon commented Jul 7, 2022

I wonder how "jarring" the experience would be for individuals to see localized labels and en-US descriptions when the package metadata hasn't been localized.

I expect that's the experience they are dealing with today.

Given the manifest keys are en-US based and we would display the localized values mixed with en-US values it's probably already an inconsistent experience.

Maybe localizing the titles would improve the experience for manifests with localizations. We've got a feature on wingetcreate to make localizing metadata easier:

I think I'm good going down the path of localizing the titles. @JohnMcPMS thoughts?

@JohnMcPMS
Copy link
Member

The "titles"? As in the field name parts in show? I think they already are being localized.

<data name="ShowLabelInstallerLocale" xml:space="preserve">
<value>Gebietsschema:</value>
</data>

@yao-msft
Copy link
Contributor

yao-msft commented Jul 7, 2022

I think last time we discussed that we would de-localize the manifest keys for show, for scenarios Demitrius mentioned. Are we ok not doing that now?

@denelon
Copy link
Contributor

denelon commented Jul 7, 2022

If they are already localized, yes. The changes we're making here should be fine. There may be better renditions for things like "URL" as opposed to "Url" where the casing is unique to YAML/JSON styles.

@JohnMcPMS
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@JohnMcPMS
Copy link
Member

Not that a build is needed... just following protocol.

@yao-msft yao-msft merged commit ada3bf5 into microsoft:master Jul 29, 2022
@Trenly Trenly deleted the ShowStandardization branch July 29, 2022 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Output Issue related to CLI output Issue-Feature This is a feature request for the Windows Package Manager client.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update "show" output
4 participants