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

Improve docs around Layer manager #831

Open
jps opened this issue Apr 17, 2023 · 0 comments
Open

Improve docs around Layer manager #831

jps opened this issue Apr 17, 2023 · 0 comments
Labels
docs Improvements or additions to documentation
Milestone

Comments

@jps
Copy link
Contributor

jps commented Apr 17, 2023

Description

Currently, we have several components that use the layer manager

  • modal
  • drawer
  • select
  • tooltip?
  • popover?

It's not always clear to users how they should use the layer manager, we should improve each of these component pages by linking off to the layer manager and making mention the fact that if they want to adjust on what layer the component sits they will have to do it via this mechanism.

See #825 for feedback from @tbradbury

Tasks/Steps

-Each of these component documentation pages should refer to the layer – add an inline message to these pages
-Audit each of the components that make use of the layer component:
- make sure that any legacy props or references to z-index are removed if no longer in use
- mark unused z-index as deprecated

  • Add extra storybook scenarios for each component to illustrate layer usage

Acceptance Criteria

As a developer, it should be straightforward how I use layer components and how I adjust.

@jps jps added triage This issue will be reviewed by the team task A non user facing change labels Apr 17, 2023
@jps jps added this to the Documentation milestone Apr 17, 2023
@jps jps added this to NewsKit Apr 17, 2023
@github-project-automation github-project-automation bot moved this to Triage in NewsKit Apr 17, 2023
@jps jps moved this from Triage to Backlog in NewsKit Apr 17, 2023
@jps jps removed the triage This issue will be reviewed by the team label Apr 18, 2023
@jps jps moved this from Backlog to Analysis in NewsKit Apr 25, 2023
@jps jps added docs Improvements or additions to documentation and removed task A non user facing change labels May 2, 2023
@LukeFinch LukeFinch moved this from Analysis to Ready to do in NewsKit May 11, 2023
@mutebg mutebg moved this from Ready to do to Peer review in NewsKit Jun 14, 2023
@mutebg mutebg moved this from Peer review to Ready to do in NewsKit Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: Ready to do
Development

No branches or pull requests

1 participant