Skip to content

Metric chart docs#6447

Merged
gvnmagni merged 16 commits intoelastic:mainfrom
gvnmagni:datavisdocs
Feb 7, 2023
Merged

Metric chart docs#6447
gvnmagni merged 16 commits intoelastic:mainfrom
gvnmagni:datavisdocs

Conversation

@gvnmagni
Copy link
Copy Markdown
Contributor

@gvnmagni gvnmagni commented Dec 1, 2022 •
edited by markov00
Loading

Summary

Within the already existing Elastic Charts documentation, the PR adds one new page about Metric Chart.
These pages act as the other EUI components, showing how to use them, the constraints, limitations, and good practices.
More pages will come in the future (other charts).

@markov00 markov00 changed the title Added data visualization docs Metric chart docs Jan 31, 2023
@markov00 markov00 added skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation) documentation Issues or PRs that only affect documentation - will not need changelog entries Elastic Charts labels Jan 31, 2023
@markov00 markov00 marked this pull request as ready for review January 31, 2023 14:14
@markov00 markov00 requested review from a team and nickofthyme January 31, 2023 14:14
drewdaemon
drewdaemon reviewed Jan 31, 2023
View reviewed changes
Copy link
Copy Markdown

@drewdaemon drewdaemon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These docs are just beautiful.

I suggested corrections for a few typos, but the content seems like everything it should be.

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Feb 1, 2023

Preview documentation changes for this PR: https://eui.elastic.co/pr_6447/

@cee-chen
Copy link
Copy Markdown
Contributor

cee-chen commented Feb 1, 2023

@gvnmagni I have some very minor chore type change requests, mostly around making sure demo code/codesandbox links are available etc. - would you be cool if I pushed them up directly to your branch?

@gvnmagni
Copy link
Copy Markdown
Contributor Author

gvnmagni commented Feb 2, 2023

@gvnmagni I have some very minor chore type change requests, mostly around making sure demo code/codesandbox links are available etc. - would you be cool if I pushed them up directly to your branch?

Yes please, feel free to go ahead! 😊

@elastic elastic deleted a comment from kibanamachine Feb 2, 2023
@elastic elastic deleted a comment from kibanamachine Feb 2, 2023
@elastic elastic deleted a comment from kibanamachine Feb 2, 2023
@elastic elastic deleted a comment from kibanamachine Feb 2, 2023
@elastic elastic deleted a comment from kibanamachine Feb 2, 2023
nickofthyme
nickofthyme approved these changes Feb 2, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@nickofthyme nickofthyme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is amazing! Great work @gvnmagni 🎉

I wasn't sure if you want to have images for both light and dark theming. I don't think it's a big deal either way but could be a nice touch since the demos below are changing with the theme.

image

@nickofthyme
Copy link
Copy Markdown
Contributor

nickofthyme commented Feb 2, 2023

FYI new metric breakpoints are now available in @elastic/charts@53.1.0 thanks to elastic/elastic-charts#1951

@cee-chen
Copy link
Copy Markdown
Contributor

cee-chen commented Feb 2, 2023

@gvnmagni I was originally going to add Demo TS tabs to every example missing one, but it occurred to me that you got most of them and maybe the exclusion was an intentional design decision on your part. Just to check, can you confirm that the below sections should not have demo code that consumers can copy/open in CodeSandbox?

  1. The first When to use/Overview demo
  2. The Resizing demo
  3. The No data demo

Thanks! Other than that question, this is looking great to me!

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Feb 2, 2023

Preview documentation changes for this PR: https://eui.elastic.co/pr_6447/

@gvnmagni
Copy link
Copy Markdown
Contributor Author

gvnmagni commented Feb 6, 2023

I can confirm that @cee-chen, they are not supposed to have the Demo TS tab. Thank you for checking and for noticing that 😊

@markov00
Copy link
Copy Markdown
Contributor

markov00 commented Feb 6, 2023

thanks @cee-chen I confirm too that those sections don't need a Demo TS tab.

@elizabetdev elizabetdev self-requested a review February 6, 2023 14:45
@elizabetdev elizabetdev mentioned this pull request Feb 6, 2023
Closed
elizabetdev
elizabetdev suggested changes Feb 6, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@elizabetdev elizabetdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's looking good. I just found two small issues.

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Feb 7, 2023

Preview documentation changes for this PR: https://eui.elastic.co/pr_6447/

elizabetdev
elizabetdev approved these changes Feb 7, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@elizabetdev elizabetdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @markov00 and @gvnmagni! LGTM! 🎉

@gvnmagni gvnmagni merged commit 287746d into elastic:main Feb 7, 2023
@gvnmagni gvnmagni deleted the datavisdocs branch February 8, 2023 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markov00 markov00 markov00 left review comments

@nickofthyme nickofthyme nickofthyme approved these changes

+2 more reviewers

@drewdaemon drewdaemon drewdaemon left review comments

@elizabetdev elizabetdev elizabetdev approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@gvnmagni @kibanamachine @cee-chen @nickofthyme @markov00 @drewdaemon @elizabetdev