plots: copy edit walkthrough and dashboard tooltips #1922

jorgeorpinel · 2022-06-17T05:20:32Z

No description provided.

reformat md links

jorgeorpinel · 2022-06-19T00:06:44Z

Should I feel free to merge (my) approved PRs in this repo? Thanks

shcheklein · 2022-06-19T00:36:33Z

@jorgeorpinel I'll review it, haven't had time yet

webview/src/plots/components/PlotsContainer.tsx

extension/resources/walkthrough/plots.md

shcheklein · 2022-06-20T00:06:23Z

extension/resources/walkthrough/plots.md

-sections for selected experiments, that correspond to the different
-[types of plots](https://dvc.org/doc/command-reference/plots#supported-file-formats)
-supported by DVC:
+If you're using Python, the [DVCLive] helper library can save plots data for


You are adding too much context to the page, too much structure. It tried as much as I can to keep it in a way that at least on my 13'' screen I can see some actual plots screenshots when open it

too much structure

Are you referring to the H2s further down? Also not a strong opinion, I guess it's a stylistic choice. IMO it looks better and clearer (# Plots > ## Plot types) and again it doesn't make the page longer. But I'm happy to flatten it if you confirm that's what we're talking about.

It's not about the page length per se. It's about when I can see any plots on the page that is called "Plots". We want the screenshot with them visible asap. Adding more paragraphs, structure, etc are making it more and more like a tutorial. We should be throwing out things if possible, not adding them. It's similar to DVC's get started - we are fighting for every symbol here.

We should be throwing out things if possible... we are fighting for every symbol

OK, I compressed it again, in fact I merged a few things to make it even shorter. PTAL

It's about when I can see any plots on the page that is called "Plots"

Maybe we should move the 💡 tip about setting up plots to the bottom then? Or just link to DVC docs

extension/resources/walkthrough/plots.md

shcheklein · 2022-06-20T00:09:24Z

webview/src/plots/components/PlotsContainer.tsx

  [Section.CHECKPOINT_PLOTS]:
-    'Linear plots based on data from the experiments table.',
+    'Real-time graphs based on metrics from the Experiments Table',


Let's create a ticket please to being able to include links into these descriptions.

keep all three sections visible, if section is empty, show the same message instead of it's content

Ticket created: #1933

Do you also think "graphs" is also not good here? I like it better here since trends charts are not regular DVC plots but rather an extension-specific feature I think. Or does DVCLive also update regular plots in your browser? Anyway, feel free to also commit this if you prefer so:

Suggested change

'Real-time graphs based on metrics from the Experiments Table',

'Real-time plots based on metrics from the Experiments Table',

yes. Also not sure about making it the "Experiments Table" tbh.

It was already "Experiments Table". That's the official name we give to that custom VS Code Editor I think?

sorry, I meant capitalization - should it be "Experiments Table" or just "experiments table" in these descriptions?

I like capitalization and bolding since each one has a walkthrough page. No strong opinion

BTW this page should be Plots Dashboard, I think (bit stronger opinion there).

okay, let's keep it

jorgeorpinel

Another 2 places where we have "graph" at the moment. Up to you guys, thanks:

extension/resources/walkthrough/plots.md

webview/src/plots/components/PlotsContainer.tsx

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

per #1922 (comment)

…-dvc into editors/plots-dashboard

per #1922 (comment)

jorgeorpinel · 2022-06-20T22:05:10Z

extension/resources/walkthrough/plots.md

+[**Plots Dashboard**](command:dvc.showPlots). Use
+[`DVC: Show Plots`](command:workbench.action.quickOpen?%22>DVC:%20Show%20Plots%22)


Do we need both links? I think they do the same thing in the end.

it educates ppl a bit more

extension/resources/walkthrough/plots.md

codeclimate · 2022-06-20T22:40:19Z

Code Climate has analyzed commit 5f4d273 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (85% is the threshold).

This pull request will bring the total coverage in the repository to 96.6% (0.0% change).

View more on Code Climate.

jorgeorpinel added 3 commits June 17, 2022 00:18

walks: link to Vega-lite docs from Plots and

49eec05

reformat md links

plots: better tooltips from Dashboard

2b6b8f1

walks: copy edit Plots

64b624d

jorgeorpinel marked this pull request as ready for review June 17, 2022 05:54

jorgeorpinel requested review from mattseddon, rogermparent, sroy3 and wolmir as code owners June 17, 2022 05:54

jorgeorpinel changed the title ~~plots: copy edits walkthrough and dashboard tooltips~~ plots: copy edit walkthrough and dashboard tooltips Jun 17, 2022

jorgeorpinel self-assigned this Jun 17, 2022

sroy3 approved these changes Jun 17, 2022

View reviewed changes

jorgeorpinel commented Jun 19, 2022

View reviewed changes

webview/src/plots/components/PlotsContainer.tsx Outdated Show resolved Hide resolved

shcheklein reviewed Jun 20, 2022

View reviewed changes

extension/resources/walkthrough/plots.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 20, 2022

View reviewed changes

extension/resources/walkthrough/plots.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 20, 2022

View reviewed changes

Merge branch 'main' into editors/plots-dashboard

4b641c8

jorgeorpinel mentioned this pull request Jun 20, 2022

Plots sections: enable linking in the plots tooltips, other improvements #1933

Closed

2 tasks

jorgeorpinel commented Jun 20, 2022

View reviewed changes

extension/resources/walkthrough/plots.md Outdated Show resolved Hide resolved

webview/src/plots/components/PlotsContainer.tsx Outdated Show resolved Hide resolved

jorgeorpinel and others added 7 commits June 20, 2022 12:32

Update extension/resources/walkthrough/plots.md

51e4f48

Update webview/src/plots/components/PlotsContainer.tsx

abc0ff8

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

Update extension/resources/walkthrough/plots.md

c6bed38

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

walks: shorten Plots

562bae5

per #1922 (comment)

Merge branch 'editors/plots-dashboard' of github.com:iterative/vscode…

5f4d273

…-dvc into editors/plots-dashboard

plots: graph -> plot/visualize

a9bb31b

walks: Plots +Dashboard

2151326

per #1922 (comment)

jorgeorpinel requested review from shcheklein and sroy3 June 20, 2022 22:04

jorgeorpinel commented Jun 20, 2022

View reviewed changes

move code

376b3d0

jorgeorpinel commented Jun 20, 2022

View reviewed changes

extension/resources/walkthrough/plots.md Outdated Show resolved Hide resolved

Update extension/resources/walkthrough/plots.md

76a5b79

shcheklein approved these changes Jun 22, 2022

View reviewed changes

jorgeorpinel merged commit 79a52d5 into main Jun 23, 2022

jorgeorpinel deleted the editors/plots-dashboard branch June 23, 2022 01:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

plots: copy edit walkthrough and dashboard tooltips #1922

plots: copy edit walkthrough and dashboard tooltips #1922

jorgeorpinel commented Jun 17, 2022

jorgeorpinel commented Jun 19, 2022 •

edited

Loading

shcheklein commented Jun 19, 2022

shcheklein Jun 20, 2022

This comment was marked as resolved.

jorgeorpinel Jun 20, 2022 •

edited

Loading

shcheklein Jun 20, 2022

jorgeorpinel Jun 20, 2022

shcheklein Jun 20, 2022

jorgeorpinel Jun 20, 2022

jorgeorpinel Jun 20, 2022 •

edited

Loading

shcheklein Jun 20, 2022

jorgeorpinel Jun 20, 2022

shcheklein Jun 20, 2022

jorgeorpinel Jun 20, 2022

shcheklein Jun 20, 2022

jorgeorpinel left a comment

jorgeorpinel Jun 20, 2022

shcheklein Jun 22, 2022

codeclimate bot commented Jun 20, 2022

	'Real-time graphs based on metrics from the Experiments Table',
	'Real-time plots based on metrics from the Experiments Table',

		[Plots Dashboard](command:dvc.showPlots). Use
		[`DVC: Show Plots`](command:workbench.action.quickOpen?%22>DVC:%20Show%20Plots%22)

plots: copy edit walkthrough and dashboard tooltips #1922

plots: copy edit walkthrough and dashboard tooltips #1922

Conversation

jorgeorpinel commented Jun 17, 2022

jorgeorpinel commented Jun 19, 2022 • edited Loading

shcheklein commented Jun 19, 2022

Choose a reason for hiding this comment

This comment was marked as resolved.

jorgeorpinel Jun 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Jun 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codeclimate bot commented Jun 20, 2022

jorgeorpinel commented Jun 19, 2022 •

edited

Loading

jorgeorpinel Jun 20, 2022 •

edited

Loading

jorgeorpinel Jun 20, 2022 •

edited

Loading