IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-22 08:56:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Storybook: Rework the intro page (#77305)

Browse Source
This commit is contained in:
Joao Silva 2023-10-30 16:53:49 +00:00 committed by GitHub
parent 5118ac9abd
commit 7430cce0e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/grafana-ui/README.md
View File

@ -1,7 +1,5 @@
# Grafana UI components library
> **@grafana/ui is currently in BETA**.
@grafana/ui is a collection of components used by [Grafana](https://github.com/grafana/grafana)
Our goal is to deliver Grafana's common UI elements for plugins developers and contributors.

20
packages/grafana-ui/src/Intro.mdx
View File

@ -2,11 +2,9 @@ import { Meta } from '@storybook/blocks';
<Meta title="Docs Overview/Intro" parameters={{ options: { isToolshown: false }, id: 1 }} />
# Grafana design system
# Grafana React Components
> **@grafana/ui is currently in BETA**.
With the design system @grafana/ui, we want to democratize development. This library of reusable [Grafana](https://github.com/grafana/grafana) components and guidelines helps you with contribution and plugin development.
With @grafana/ui, we want to democratize development. This library of reusable [Grafana](https://github.com/grafana/grafana) components and guidelines is part of the [Saga Design System](https://grafana.com/developers/saga/About/overview) and should help you with contribution and plugin development.
## Our vision
@ -17,23 +15,19 @@ Grafana Labs started @grafana/ui to make contributing to Grafana as easy as poss
- A beautiful, visually consistent Grafana experience.
- Transparency about how we work and what we do.
### Maintained by Grafana Labs and you
Grafana Labs has a task force that helps create and maintain components. We make sure that components are documented and easy to use. The current status of the @grafana/ui development is available on [GitHub](https://github.com/grafana/grafana/projects/26). Feel free to contribute!
### How to get involved
When we notice that we need to change something, we determine together what the change should be, then we put the change in place and communicate it publicly. Developers and designers create and improve @grafana/ui together. Throughout the process, we strive to involve you and meet your needs. We are looking forward to discussing your design and improvement ideas on [GitHub](https://github.com/grafana/grafana/projects/26).
When we notice that we need to change something, we determine together what the change should be, then we put the change in place and communicate it publicly. Developers and designers create and improve @grafana/ui together. Throughout the process, we strive to involve you and meet your needs. We are looking forward to discussing your design and improvement ideas, find out how you can help in the [Contribution Guidelines](https://grafana.com/developers/saga/contributing).
## Get started
- **Explore UI components**
Click on any of the component in the sidebar to see how they look, and how to configure them. Each component pages contains documentation of its properties, as well as code examples for how to use it.
Click on any of the components in the sidebar to see how they look, and how to configure them. Each component contains documentation of its properties, as well as code examples for how to use it.
- **Try them out**
- Experiment with different properties, by clicking **Canvas** at the top of each component page.
- Change the properties under **Knobs** in the bottom panel.
- Experiment with different properties, by clicking on each component story.
- Change the properties under **Controls** in the side panel.
- **Use them**
Once you've found the right component for your use case, click the **Story** tab to see the code implementation, or look at examples under **Docs**.
Once you've found the right component for your use case, click the **Code** tab to see the code implementation, or look at examples under **Docs**.
For more details, refer to the [package source](https://github.com/grafana/grafana/tree/main/packages/grafana-ui).