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

horizontal bar plot docs #3964

Merged
merged 4 commits into from
Sep 19, 2022
Merged

horizontal bar plot docs #3964

merged 4 commits into from
Sep 19, 2022

Conversation

tibor-mach
Copy link
Contributor

Solves #3953

@@ -492,3 +492,46 @@ file:///Users/usr/src/dvc_plots/index.html
```

![](/img/plots_show_confusion_normalized.svg)

Copy link
Member

Choose a reason for hiding this comment

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

@tibor-mach something funny is happening here 🤔 Did you run the pre-commit hook?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't because the .pre-commit-config.yaml seems to be missing in the repo. There is a .pre-commit-hooks.yaml file but it is not a valid config...so I am bit confused about how I can run it.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, in this case it's installed if you run yarn.

Copy link
Member

Choose a reason for hiding this comment

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

Here are a bit more details - https://dvc.org/doc/contributing/docs#development-environment, but you don't need to run everything. And we are figuring out how to simplify the workflow for the external contributors. We had an external tool (Restyled) that was taking care of running linters and creating a fixed PR on top of a contribution.

Copy link
Contributor Author

@tibor-mach tibor-mach Sep 18, 2022

Choose a reason for hiding this comment

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

I did run yarn though. I set up a locally hosted version of the website with yarn develop and had it opened as I was editing the code.

I now also ran all the liters etc. manually. Everything seems to be fine. Building it also works fine...

I do get the following warning and error when I run yarn develop though. Not sure if this might have something to do with the problem here (I am not exactly sure what the problem is as it works on my machine :-) ... Perhaps a devcontainer would help here ... )

(process:22910): GModule-CRITICAL **: 21:18:59.521: g_module_make_resident: assertion 'module != NULL' failed

(process:22910): VIPS-WARNING **: 21:18:59.521: unable to load "/usr/lib/vips-modules-8.13/vips-jxl.so" -- libjxl_threads.so.0.6: cannot open shared object file: No such file or directory

@shcheklein
Copy link
Member

@iterative/websites folks we need to figure out deployments, restyled, etc for the external contributors when we have time. Something happened to the restyled. Can we use the logic similar to the one we did in PyDrive2 that @0x2b3bfa0 discovered (using pull_request_target and deployments to approve runs - https://github.com/iterative/PyDrive2/blob/main/.github/workflows/test.yml ?)

@shcheklein shcheklein temporarily deployed to dvc-org-main-ffxxiia534cu28qo8 September 18, 2022 18:49 Inactive
@shcheklein
Copy link
Member

Okay, it works fine https://dvc-org-main-ffxxiia534cu28qo8.herokuapp.com/doc/command-reference/plots/show#example-horizontal-bar-plot

I think GH highlights it for a different reason (malformed JSON above on the page)

Linters also work fine and there are no problems.

@shcheklein shcheklein temporarily deployed to dvc-org-main-ffxxiia534cu28qo8 September 18, 2022 19:35 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-main-ffxxiia534cu28qo8 September 18, 2022 20:51 Inactive
@shcheklein shcheklein merged commit c099bba into iterative:main Sep 19, 2022
@github-actions
Copy link
Contributor

c099bba

Link Check Report

There were no links to check!

CML watermark

@rogermparent
Copy link
Contributor

Maybe re-creating the external applications we use like Restyled within our lint pipeline could cut down on weirdness: If GHA is down, CI is down, with no other delays.

We don't have to port everything at once, but I definitely think Restyled shouldn't be too difficult to replicate in our CI- I'd imagine we just have to commit and/or open a PR with the results of prettier --write and/or eslint --fix if anything changes.

@shcheklein
Copy link
Member

@rogermparent yes, I agree and we discussed this with @yathomasi - we have a lot of stuff in place to make it quick I think. CML can help a lot with creating and updating PRs - it's literally one-two lines, and we can reuse the same mechanism for approvals as we do in PyDrive2 and CML (abusing the deployments). We should probably create a ticket for this.

@yathomasi
Copy link
Contributor

We should probably create a ticket for this.

We already have one: #3970

Comment on lines +282 to +284
- `bar_horizontal` - horizontal bar plot, see
[example](/doc/command-reference/plots/show#example-horizontal-bar-plot)
- `bar_horizontal_sorted` - horizontal bar plot sorted by bar size
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor: I think "bar chart" is much more widely used. But surprisingly (for me) term "bar plot" is not insignificant out there 🤷🏼

@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference labels Oct 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference
Projects
None yet
Development

Successfully merging this pull request may close these issues.

plots: add bar_horizontal and bar_horizontal_sorted templates
6 participants