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.

Sign up for GitHub

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

Jump to bottom

Audit and update component usage snippets #6374

Closed
83 tasks done
geospatialem opened this issue Jan 29, 2023 · 7 comments
Closed
83 tasks done

Audit and update component usage snippets #6374

geospatialem opened this issue Jan 29, 2023 · 7 comments
Assignees
@geospatialem @DitwanP
Labels
4 - verified Issues that have been released and confirmed resolved. docs Issues relating to documentation updates only. estimate - 8 Requires input from team, consider smaller steps. p - low Issue is non core or affecting less that 10% of people using the library
Milestone
2023 December Pri...

Comments

@geospatialem
Copy link
Member

geospatialem commented Jan 29, 2023 •
edited by DitwanP
Loading

Description

Audit and update all component usage snippets in the <component>/usage folder 📁. Created based on feedback pertaining to the Action usage snippet, which references a removed slot in #6371.

The audit should determine:

  1. If all usage snippets are up-to-date with props, slots, etc.
    • If not, usage snippets should be cleaned up and/or removed
  2. If additional use snippets should be added to showcase the component effectively.
  3. Ensure our usage snippets are professional for others to consume.

Which Component

All components

  • accordion
  • accordion-item
  • action
  • action-bar
  • action-group
  • action-menu
  • action-pad
  • alert
  • avatar
  • block
  • block-section
  • button
  • card
  • checkbox
  • chip
  • chip-group
  • color-picker
  • combobox
  • combobox-item
  • combobox-item-group
  • date-picker
  • dropdown
  • dropdown-group
  • dropdown-item
  • fab
  • filter
  • flow
  • flow-item
  • icon
  • inline-editable
  • input
  • input-date-picker
  • input-message
  • input-time-picker
  • label
  • link
  • list
  • list-item
  • list-item-group
  • loader
  • modal
  • notice
  • option
  • option-group
  • pagination
  • panel
  • pick-list*
  • pick-list-group*
  • pick-list-item*
  • popover
  • progress
  • radio-button
  • radio-button-group
  • rating
  • scrim
  • segmented-control
  • segmented-control-item
  • select
  • shell
  • shell-center-row
  • shell-panel
  • slider
  • split-button
  • stepper
  • stepper-item
  • switch
  • tab
  • tab-nav
  • tab-title
  • tabs
  • text-area
  • tile
  • tile-select
  • tile-select-group
  • time-picker
  • tip
  • tip-group
  • tip-manager
  • tooltip
  • tree
  • tree-item
  • value-list*
  • value-list-item*

Resources

For instance, the Action component references a tooltip slot, which was created with the now removed tooltip-manager component and is no longer relevant.

*: Component is deprecated so the usage snippets were left as is.
@geospatialem geospatialem added docs Issues relating to documentation updates only. 0 - new New issues that need assignment. labels Jan 29, 2023
@geospatialem geospatialem self-assigned this Jan 29, 2023
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. labels Jan 29, 2023
@brittneytewks brittneytewks added the p - low Issue is non core or affecting less that 10% of people using the library label Mar 21, 2023
@geospatialem geospatialem added the estimate - 5 A few days of work, definitely requires updates to tests. label Mar 21, 2023
@geospatialem geospatialem added estimate - 8 Requires input from team, consider smaller steps. and removed estimate - 5 A few days of work, definitely requires updates to tests. labels Mar 30, 2023
@DitwanP DitwanP mentioned this issue Nov 16, 2023
Merged
DitwanP added a commit that referenced this issue Nov 16, 2023
@DitwanP @jcfranco
@driskull @benelan @macandcheese
docs(label, list): update usage examples (#8192)
e084378 
**Related Issue:** #6374 

## Summary

Updates component usage examples for the label and list components

---------

Co-authored-by: JC Franco <jfranco@esri.com>
Co-authored-by: Matt Driscoll <mdriscoll@esri.com>
Co-authored-by: Ben Elan <no-reply@benelan.dev>
Co-authored-by: jcfranco <jcfranco@users.noreply.github.com>
Co-authored-by: Adam Tirella <adam@tirel.la>
benelan added a commit that referenced this issue Nov 24, 2023
@DitwanP @jcfranco
@driskull @benelan @macandcheese
docs(label, list): update usage examples (#8192)
add71c7 
**Related Issue:** #6374

Updates component usage examples for the label and list components

---------

Co-authored-by: JC Franco <jfranco@esri.com>
Co-authored-by: Matt Driscoll <mdriscoll@esri.com>
Co-authored-by: Ben Elan <no-reply@benelan.dev>
Co-authored-by: jcfranco <jcfranco@users.noreply.github.com>
Co-authored-by: Adam Tirella <adam@tirel.la>
benelan added a commit that referenced this issue Nov 24, 2023
@DitwanP @jcfranco
@driskull @benelan @macandcheese
docs(label, list): update usage examples (#8192)
2f60131 
**Related Issue:** #6374

Updates component usage examples for the label and list components

---------

Co-authored-by: JC Franco <jfranco@esri.com>
Co-authored-by: Matt Driscoll <mdriscoll@esri.com>
Co-authored-by: Ben Elan <no-reply@benelan.dev>
Co-authored-by: jcfranco <jcfranco@users.noreply.github.com>
Co-authored-by: Adam Tirella <adam@tirel.la>
benelan added a commit that referenced this issue Nov 26, 2023
@DitwanP @jcfranco
@driskull @benelan @macandcheese
docs(label, list): update usage examples (#8192)
6a1a3cc 
**Related Issue:** #6374

Updates component usage examples for the label and list components

---------

Co-authored-by: JC Franco <jfranco@esri.com>
Co-authored-by: Matt Driscoll <mdriscoll@esri.com>
Co-authored-by: Ben Elan <no-reply@benelan.dev>
Co-authored-by: jcfranco <jcfranco@users.noreply.github.com>
Co-authored-by: Adam Tirella <adam@tirel.la>
@DitwanP
Copy link
Contributor

DitwanP commented Nov 27, 2023

Checked off the following because they either did not require any changes or usage is documented under parent components.

  • list-item
  • list-item-group
  • option
  • option-group
  • pagination
  • popover
  • progress
  • radio-button
  • radio-button-group
  • rating
  • segmented-control
  • segmented-control-item

@geospatialem LMK what you think about these and if there's something I missed. I also want to know if we should remove the pick-list related components from the audit list since there usage page say that they are deprecated.

@DitwanP DitwanP mentioned this issue Nov 27, 2023
Merged
@geospatialem
Copy link
Member Author

@geospatialem LMK what you think about these and if there's something I missed. I also want to know if we should remove the pick-list related components from the audit list since there usage page say that they are deprecated.

@DitwanP The list above LGTM!💥 Re: pick-list and value-list, could go either way on removing the usage examples since they are deprecated. It might be more work than its worth, but if you think it would be worthy to clean up - open to removal, too. 🧹

DitwanP added a commit that referenced this issue Nov 28, 2023
@DitwanP
docs(link, loader, modal, notice, panel, select): update usage exampl…
383bdf8 
…es (#8267)

**Related Issue:** #6374 

## Summary
Updates component usage examples for components listed in title
@DitwanP DitwanP mentioned this issue Dec 8, 2023
Merged
@DitwanP
Copy link
Contributor

DitwanP commented Dec 8, 2023

I think it might make sense to leave the samples for the deprecated components, if the components are still going to be there then the samples might as well be there.

That being said, I'll check of the pick-list and anything else that might be deprecated.

@DitwanP DitwanP mentioned this issue Dec 12, 2023
Merged
DitwanP added a commit that referenced this issue Dec 14, 2023
@DitwanP
docs(s-components): update usage snippets (#8384)
22d5940 
**Related Issue:** #6374

## Summary
Updating usage snippets for components that start with s
DitwanP added a commit that referenced this issue Dec 14, 2023
@DitwanP
docs(t-components): update usage snippets (#8404)
0439e2e 
**Related Issue:** #6374

## Summary
Audit the usage snippets for the components that start with "t".
@DitwanP
Copy link
Contributor

DitwanP commented Dec 14, 2023

value-list and value-list-item are deprecated so will leave those alone as well.

@DitwanP DitwanP added 3 - installed Issues that have been merged to master branch and are ready for final confirmation. and removed 2 - in development Issues that are actively being worked on. labels Dec 14, 2023
@github-actions GitHub Actions
Copy link
Contributor

Installed and assigned for verification.

@DitwanP DitwanP assigned DitwanP and unassigned DitwanP Dec 15, 2023
@geospatialem
Copy link
Member Author

All usage examples are verified and look fantastic from label through tree-item (excluding the deprecated value-list). 🎉 cc @DitwanP

@DitwanP
Copy link
Contributor

DitwanP commented Dec 18, 2023

🍬 Component usage for components starting with a through i looks good!
cc @geospatialem

@DitwanP DitwanP closed this as completed Dec 18, 2023
@DitwanP DitwanP added 4 - verified Issues that have been released and confirmed resolved. and removed 3 - installed Issues that have been merged to master branch and are ready for final confirmation. labels Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@geospatialem geospatialem

@DitwanP DitwanP

Labels
4 - verified Issues that have been released and confirmed resolved. docs Issues relating to documentation updates only. estimate - 8 Requires input from team, consider smaller steps. p - low Issue is non core or affecting less that 10% of people using the library
Projects
None yet
Milestone
2023 December Priorities
Development

No branches or pull requests
4 participants
@alisonailea @geospatialem @DitwanP @brittneytewks