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

New 7.1 Controls missing from package descriptions #4210

Closed
19 tasks
michael-hawker opened this issue Aug 31, 2021 · 4 comments · Fixed by #4251
Closed
19 tasks

New 7.1 Controls missing from package descriptions #4210

michael-hawker opened this issue Aug 31, 2021 · 4 comments · Fixed by #4251
Labels
bug 🐛 An unexpected issue that highlights incorrect behavior bugbash 🏗️ build 🔥 Completed 🔥 documentation 📃
Milestone

Comments

@michael-hawker
Copy link
Member

Describe the bug

Looks like in the NuGet package description we're missing the new controls we've added in 7.1: ContrainedBox, MetadataControl, RichSuggestBox.

Probably some of the behaviors from the behavior package.

We should add them to the package description (without going over 4000 char limit).

Steps to Reproduce

Steps to reproduce the behavior:

  1. Open VS Package Manager
  2. Find Toolkit package
  3. look at description

image

Expected behavior

Controls listed in description

Environment

NuGet Package(s): 7.1.0-rc1

Package Version(s):

Windows 10 Build Number:

  • Fall Creators Update (16299)
  • April 2018 Update (17134)
  • October 2018 Update (17763)
  • May 2019 Update (18362)
  • May 2020 Update (19041)
  • Insider Build ({build_number})

App min and target version:

  • Fall Creators Update (16299)
  • April 2018 Update (17134)
  • October 2018 Update (17763)
  • May 2019 Update (18362)
  • May 2020 Update (19041)
  • Insider Build ({build_number})

Device form factor:

  • Desktop
  • Xbox
  • Surface Hub
  • IoT

Visual Studio version:

  • 2017 (15.{minor_version})
  • 2019 (16.{minor_version})
  • 2022 (17.{minor_version})

Additional context

@michael-hawker michael-hawker added bug 🐛 An unexpected issue that highlights incorrect behavior documentation 📃 bugbash 🏗️ build 🔥 labels Aug 31, 2021
@michael-hawker michael-hawker added this to the 7.1 milestone Aug 31, 2021
@Nirmal4G
Copy link
Contributor

Nirmal4G commented Sep 4, 2021

This might not be the best way moving forward. We should instead add a ReadMe to packages locally now that NuGet Gallery supports it. Move the detailed descriptions to the ReadMe and keep only the list of controls and a short description.

@michael-hawker
Copy link
Member Author

Not sure if we want to have a readme for every package, this is mostly for folks to easily see a quick list of things in the package when finding the package on NuGet or in Visual Studio.

@Nirmal4G
Copy link
Contributor

Nirmal4G commented Sep 8, 2021

We'll still have a brief list but a little bit verbosity won't hurt anyone. Infact, it could give users an intro into the Toolkit.

michael-hawker added a commit to michael-hawker/UWPCommunityToolkit that referenced this issue Sep 15, 2021
@ghost ghost added the In-PR 🚀 label Sep 15, 2021
@ghost ghost closed this as completed in #4251 Sep 16, 2021
ghost pushed a commit that referenced this issue Sep 16, 2021
## Fixes #4210 and Fixes #4158

Cleans up sample for #4248 (though underlying issue remains to be figured out later).

Fixes a sample and cleans-up a few items we missed in our nuget packages. Just need to validate output from CI, but should be fairly straight-forward.

## PR Type

What kind of change does this PR introduce?

<!-- Please uncomment one or more options below that apply to this PR. -->

<!-- - Bugfix -->
<!-- - Feature -->
<!-- - Code style update (formatting) -->
<!-- - Refactoring (no functional changes, no api changes) -->
<!-- - Build or CI related changes -->
- Documentation content changes
- Sample app changes
<!-- - Other... Please describe: -->

## What is the current behavior?

TTB Sample was binding to the internal collection instead of showing binding to a developer provided collection.

Some new features were missing from the NuGet package info.

## What is the new behavior?

Fixed! 🎉

## PR Checklist

Please check if your PR fulfills the following requirements: <!-- and remove the ones that are not applicable to the current PR -->

- [ ] Tested code with current [supported SDKs](../#supported)
- [ ] New component
  - [ ] Pull Request has been submitted to the documentation repository [instructions](../blob/main/Contributing.md#docs). Link: <!-- docs PR link -->
  - [ ] Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
  - [ ] If control, added to Visual Studio Design project
- [ ] Sample in sample app has been added / updated (for bug fixes / features)
  - [ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
- [ ] New major technical changes in the toolkit have or will be added to the [Wiki](https://github.com/CommunityToolkit/WindowsCommunityToolkit/wiki) e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...
- [ ] Tests for the changes have been added (for bug fixes / features) (if applicable)
- [ ] Header has been added to all new source files (run _build/UpdateHeaders.bat_)
- [ ] Contains **NO** breaking changes

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below.
Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->

## Other information

<!-- Please add any other information that might be helpful to reviewers. -->
@ghost ghost added Completed 🔥 and removed In-PR 🚀 labels Sep 16, 2021
@gfreudenberger
Copy link

Thx

@ghost ghost locked as resolved and limited conversation to collaborators Nov 16, 2021
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug 🐛 An unexpected issue that highlights incorrect behavior bugbash 🏗️ build 🔥 Completed 🔥 documentation 📃
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants