Skip to content

Conversation

@captainsafia
Copy link
Member

Description

This PR adds a clearer description to the "Enable OpenAPI" open in Web API templates.

Customer Impact

This change does not introduce any functional changes but makes it easier for customers to understand what happens when they check/uncheck the "Enable OpenAPI" item in the VS new project experience.

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

This change adds more documentation and does not introduce functional changes to the UI.

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

Closes #37864

@captainsafia captainsafia requested a review from Pilchie as a code owner November 3, 2021 18:42
@ghost ghost added the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Nov 3, 2021
@ghost ghost added this to the 6.0.x milestone Nov 3, 2021
@captainsafia captainsafia added old-area-web-frameworks-do-not-use *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels and removed area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates labels Nov 3, 2021
@ghost
Copy link

ghost commented Nov 3, 2021

Hi @captainsafia. If this is not a tell-mode PR, please make sure to follow the instructions laid out in the servicing process document.
Otherwise, please add tell-mode label.

@captainsafia captainsafia added the Servicing-consider Shiproom approval is required for the issue label Nov 3, 2021
@ghost
Copy link

ghost commented Nov 3, 2021

Hi @captainsafia. Please make sure you've updated the PR description to use the Shiproom Template. Also, make sure this PR is not marked as a draft and is ready-to-merge.

To learn more about how to prepare a servicing PR click here.

@pranavkm
Copy link
Contributor

pranavkm commented Nov 3, 2021

Do we need to localize this text?

@captainsafia
Copy link
Member Author

captainsafia commented Nov 3, 2021

Do we need to localize this text?

@phenning Any guidance around how to localize here? I noticed from #30101 that it seems the localizations get inserted from the WebTools repo?

@phenning
Copy link
Member

phenning commented Nov 4, 2021

@captainsafia, I responded offline with a link to the generated files. Also, in a more general sense, the templates should be updated to use the new localization mechanism provided by the core template engine going forward. This would allow them to have their metadata localized within "dotnet new" and better streamline localization within Visual Studio. @vlada-shubina and @DavidKarlas should be able to give some guidance on this.

@bekir-ozturk
Copy link
Contributor

Hi @captainsafia,
I will describe the process of switching to new localization format. But this will require getting all your templates localized again. With release so close, I'm not sure if there is time.

Starting .NET 7, we have an MSBuild task to ease this process. This should be the way going forward. But since this PR is about .NET 6, I won't give details here. Let me know if you need to apply this to main branch and I can help you further.

Starting .NET 6, we have Template Localizer tool to help with this. You should:

  • Clone the repo to your local machine and create a branch for your changes
  • Install the TemplateLocalizer tool
  • Run the tool on your template folder (this will generate all the loc files on disk).
  • Commit and push the changes to the repo, then merge.
  • Loc team will automatically receive the loc files and provide the translations in a later PR.

You can install Template Localizer tool using:

dotnet tool install -g Microsoft.TemplateEngine.TemplateLocalizer

Run it on the root template directory using:

dotnet-template-localizer export <path_to_root_template_directory> --recursive

@leecow leecow added Servicing-approved Shiproom has approved the issue and removed Servicing-consider Shiproom approval is required for the issue labels Nov 4, 2021
@leecow leecow modified the milestones: 6.0.x, 6.0.1 Nov 4, 2021
@captainsafia
Copy link
Member Author

I responded offline with a link to the generated files. Also, in a more general sense, the templates should be updated to use the new localization mechanism provided by the core template engine going forward. This would allow them to have their metadata localized within "dotnet new" and better streamline localization within Visual Studio. @vlada-shubina and @DavidKarlas should be able to give some guidance on this.

Thanks! I've updated the localizations in the templates and created #38102 to track updating our infra.

@wtgodbe wtgodbe merged commit 923e305 into dotnet:release/6.0 Nov 10, 2021
captainsafia added a commit to captainsafia/aspnetcore that referenced this pull request Jan 20, 2022
…38062)

* Add WebApi-CSharp Template Toggle Description (dotnet#37367)

Partial fix for dotnet#37202

* Update localizations for WebApi-CSharp template

Co-authored-by: Tanay Parikh <TanayParikh@users.noreply.github.com>
captainsafia added a commit that referenced this pull request Jan 26, 2022
* Add WebApi-CSharp Template Toggle Description (#37367) (#38062)

* Add WebApi-CSharp Template Toggle Description (#37367)

Partial fix for #37202

* Update localizations for WebApi-CSharp template

Co-authored-by: Tanay Parikh <TanayParikh@users.noreply.github.com>

* Fix typo in localization file

Co-authored-by: Tanay Parikh <TanayParikh@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

old-area-web-frameworks-do-not-use *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels Servicing-approved Shiproom has approved the issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants