Added Studio docs #2455

tapadipti · 2021-05-10T12:14:09Z

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please choose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

casperdcl

High-level comments before full review:

in the long/medium term as per READMEs vs Docs #2443 needs to be moved to viewer.iterative.ai/doc or similar?
- images perhaps to be hosted under a studio folder in https://github.com/iterative/static/ - would make it easier to host docs somewhere else without binary bloat
  - studio logo: related to add logos static#1

content/docs/sidebar.json

jorgeorpinel

Structure and titles review (will commit a few of these):

content/docs/sidebar.json

content/docs/studio/create-view.md

content/docs/studio/experiments.md

content/docs/studio/get-started.md

content/docs/studio/teams.md

jorgeorpinel · 2021-05-10T22:00:27Z

content/docs/studio/visualize-exp.md

@@ -0,0 +1,42 @@
+# Visualize and compare experiements


Should "compare" be reflected in the sidebar label?

Ideally yes. But that will make the sidebar item too long. Any suggestions on how to keep it short?

we don't have time for this... Fix low hanging fruits

Yeah my initial review only focused on the overall structure with that same idea. And before reading all the content I was pretty confused by the titles. Isn't a "View" a visualization?

Reading into the View page, it's defined as "an interactive representation of the experiments run in your ML project," which sounds the same as visualizing experiments.

After reading the content in this page in detail I see that we mean specific experiments, which makes total sense. But before that this was confusing.

But yes I see now that it's not low-hanging fruit, so let's just leave this unresolved for now and we'll revisit later. Thanks

Added to new ticket #2468

jorgeorpinel · 2021-05-10T22:03:11Z

@tapadipti please git pull. Thanks for this BTW! 🎉

casperdcl

Good stuff.

Half the full review so far 🚧

Feel free to contest suggestions.

content/docs/studio/create-view.md

content/docs/studio/get-started.md

Co-authored-by: Jorge Orpinel <[email protected]> Co-authored-by: Casper da Costa-Luis <[email protected]>

tapadipti · 2021-05-11T08:49:24Z

src/components/Documentation/Layout/SidebarMenu/studio_gray_icon.svg

@@ -0,0 +1,457 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>


@jorgeorpinel @casperdcl Do you know who creates the logo/icon SVGs? I created a grayscale one for Studio from the color one using a tool called Inkscape, but I think a simpler one could be created. Not sure who would be doing this.

I've been concerned about resource fragmentation (full summary in iterative/static#1) - particularly for logos and the issues it's been causing with updating (e.g. iterative/cml.dev#50). In fact I've already been working on optimised monochrome versions (iterative/static#1 (comment)) using Inkscape amongst other tools. I guess @arcticbear can advise?

@tapadipti @casperdcl I can help with that, what sizes and formats do you need?

A small svg to be used in the sidebar (in place of the bullet point). The one I am currently using can be found here https://dvc-org-studio-docs-vntpxfoqdz.herokuapp.com/doc

Added to new ticket #2469

@tapadipti I've updated the images and pushed them into the main branch. You can check it out.

Co-authored-by: Jorge Orpinel <[email protected]>

tapadipti · 2021-05-12T08:31:56Z

quick comment since we want to merge soon before sorting out remaining minor issues:

Can you move all the added images to https://github.com/iterative/static/tree/main/img (and link to them using https://static.iterative.ai/img/ rather than /img/)? This would avoid bloating this repo's history when we revisit the images later.

@casperdcl I should directly commit it to the main branch, right? And, will the images load when I run the server locally?

tapadipti · 2021-05-12T08:40:56Z

I've updated the link to Studio in the docs. It is now pointing to https://studio.iterative.ai Since this link isn't working currently, the tests are failing. Will re-check once @JIoJIaJIu updates https://github.com/iterative/viewer/issues/1891

tapadipti · 2021-05-12T08:45:46Z

The only thing that worries me a little (for the release) are the small/unreadable images

@jorgeorpinel I've changed one image. For others (small images), hopefully the image borders will help for now.

Looking forward to working with you more on docs

yep :) And thanks for all your review comments.

…tic folder in this repo

…o-docs

iesahin

Fixed a few minor things here and there. Thank you @tapadipti 🙏🏼 That's great content.

tapadipti · 2021-05-12T10:26:32Z

@jorgeorpinel I don't have merge access (got this "The base branch restricts merging to authorized users."). Can you merge this pls.

jorgeorpinel

Couple comments on @iesahin last minute edits (thanks for the typo fixes)

For the next iteration. Although we'll probably rephrase lots of the text anyway. The Q now is what's the priority? Let's discuss during docs planning.

jorgeorpinel

Oops forgot to post them lol

jorgeorpinel · 2021-05-12T15:23:08Z

content/docs/studio/create-view.md

-   hover over the required repository and click on `Connect`.
+   hover over the required repository and click `Connect`.


potayto, potahto 😬

I checked some usage SO question for this :) It's potato :))

jorgeorpinel · 2021-05-12T15:23:18Z

content/docs/studio/create-view.md

-  view may be present in a data remote (cloud storage or another location
-  outside of the Git repo). If you want to include such data in your views, then
-  you will have to grant DVC Studio access to the data remote.
+  view may be present in a <abbr>data remote</abbr> (cloud storage or another


No such tooltip (yet)

Don't we have remote?

Ah, I think this only on my fork. Missed it, sorry.

jorgeorpinel · 2021-05-12T15:23:30Z

content/docs/studio/index.md

- **Run CI/CD for your ML projects on cloud resources of your choice without any
-  new tools.**
+- **Run [CI/CD](https://en.wikipedia.org/wiki/CI/CD) for your ML projects on


In #2468 there is a checkbox that reads "The CI/CD part may need more explaining/linking" and the easiest way to link was Wikipedia. 😅 We can replace it with a concept page sometime I think.

Yes, it's a good idea for now. I meant explaining CML runners I guess, or something related with CML. But not for this iteration. Anyway, we'll review when possible.

* #2468 Studio docs enhancements - initiated task * Changed the structure of the "teams" page + Added more details in the "experiments" page * Updated images + Some minor style changes * Text changes as per PR #2455 review comments * Added section on GH app installation + other small changes * Added clarification in the GitHub app section * Minor correction * Added a separate page for view settings * Clarified that DVC or non-DVC repos can be used with Studio * Added links to Studio in the DVC docs and banner * Added Studio icon in the banner * Apply suggestions from code review Co-authored-by: Casper da Costa-Luis <[email protected]> * Restyled by prettier * Added videos * Changed the intro of Studio docs as per Ivan's comment in the PR * Added DVC benefits, data remotes access details + some other changes * Small changes as per PR comments Co-authored-by: Casper da Costa-Luis <[email protected]> Co-authored-by: Restyled.io <[email protected]>

tapadipti and others added 6 commits May 5, 2021 14:14

Initialized docs for Studio

76acd79

Completed the structure of studio docs and added content to some files

d8dc64b

Update studio docs and add static images

a4e1813

Prettified cml-experiments.md

54a6b21

Added docs for team creation and incorporated some feedback from Ivan

a7665b4

Completed draft of docs to be shared with the team

aff29ea

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 10, 2021 12:14 Inactive

tapadipti requested a review from iesahin May 10, 2021 12:14

iesahin requested a review from jorgeorpinel May 10, 2021 12:47

Removed the paragraph on CML from experiments.md

0cb54e8

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 10, 2021 14:58 Inactive

casperdcl suggested changes May 10, 2021

View reviewed changes

jorgeorpinel reviewed May 10, 2021

View reviewed changes

content/docs/sidebar.json Outdated Show resolved Hide resolved

jorgeorpinel suggested changes May 10, 2021

View reviewed changes

Apply suggestions from code review

9ffd9af

jorgeorpinel temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 10, 2021 22:02 Inactive

casperdcl suggested changes May 10, 2021

View reviewed changes

Apply suggestions from code review

4462653

Co-authored-by: Jorge Orpinel <[email protected]> Co-authored-by: Casper da Costa-Luis <[email protected]>

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 11, 2021 05:50 Inactive

restyled-io bot mentioned this pull request May 11, 2021

Restyle Added Studio docs #2464

Closed

Incorporated PR review comments

6ec82c3

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 11, 2021 06:22 Inactive

Moved Studio before DVCLive + other changes from PR review

49e66fe

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 11, 2021 06:40 Inactive

Added grayscale icon for Studio

82550d1

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 11, 2021 08:19 Inactive

tapadipti commented May 11, 2021

View reviewed changes

casperdcl mentioned this pull request May 11, 2021

add logos iterative/static#1

Merged

Changed the image for trends chart

15f1b71

Accepted PR suggestion (minor change to teams text)

7eb44e3

Co-authored-by: Jorge Orpinel <[email protected]>

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 12, 2021 05:42 Inactive

Prettified + typo correction

1b14980

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 12, 2021 05:47 Inactive

Incorporated PR suggestions

4ba41b1

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 12, 2021 08:26 Inactive

Clarified about advanced settings and experiments

997f022

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 12, 2021 09:21 Inactive

Used Studio images from the static repo and deleted them from the sta…

0640323

…tic folder in this repo

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 12, 2021 10:01 Inactive

tapadipti requested a review from casperdcl May 12, 2021 10:03

casperdcl approved these changes May 12, 2021

View reviewed changes

iesahin added 2 commits May 12, 2021 13:11

Minor edits for typos, "click on" -> click, etc.

6a96e64

Merge branch 'studio-docs' of github.com:iterative/dvc.org into studi…

8d14bc3

…o-docs

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 12, 2021 10:14 Inactive

Merge branch 'master' into studio-docs

2fb4a5d

shcheklein temporarily deployed to dvc-org-studio-docs-vntpxfoqdz May 12, 2021 10:18 Inactive

iesahin approved these changes May 12, 2021

View reviewed changes

shcheklein merged commit 36da40d into master May 12, 2021

casperdcl deleted the studio-docs branch May 12, 2021 13:47

jorgeorpinel reviewed May 12, 2021

View reviewed changes

jorgeorpinel assigned tapadipti May 12, 2021

tapadipti added a commit that referenced this pull request May 28, 2021

Text changes as per PR #2455 review comments

b7915fe

tapadipti mentioned this pull request Feb 9, 2023

dvclive: Document more monitoring options #4306

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Studio docs #2455

Added Studio docs #2455

tapadipti commented May 10, 2021

casperdcl left a comment

jorgeorpinel left a comment

This comment was marked as resolved.

jorgeorpinel May 10, 2021

tapadipti May 11, 2021

This comment was marked as resolved.

This comment was marked as resolved.

jorgeorpinel May 12, 2021 •

edited

Loading

tapadipti May 12, 2021

jorgeorpinel commented May 10, 2021

casperdcl left a comment

tapadipti May 11, 2021

casperdcl May 11, 2021 •

edited

Loading

arcticbear May 11, 2021 •

edited

Loading

tapadipti May 11, 2021

tapadipti May 12, 2021

arcticbear May 12, 2021

tapadipti commented May 12, 2021

tapadipti commented May 12, 2021

tapadipti commented May 12, 2021

iesahin left a comment

tapadipti commented May 12, 2021

jorgeorpinel left a comment

jorgeorpinel left a comment

jorgeorpinel May 12, 2021

iesahin May 12, 2021

jorgeorpinel May 12, 2021

jorgeorpinel May 12, 2021

iesahin May 12, 2021

jorgeorpinel May 12, 2021

iesahin May 12, 2021

jorgeorpinel May 12, 2021

		@@ -0,0 +1,457 @@
		<?xml version="1.0" encoding="UTF-8" standalone="no"?>

		hover over the required repository and click on `Connect`.
		hover over the required repository and click `Connect`.

Added Studio docs #2455

Added Studio docs #2455

Conversation

tapadipti commented May 10, 2021

casperdcl left a comment

Choose a reason for hiding this comment

jorgeorpinel left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

jorgeorpinel May 12, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel commented May 10, 2021

casperdcl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

casperdcl May 11, 2021 • edited Loading

Choose a reason for hiding this comment

arcticbear May 11, 2021 • 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

tapadipti commented May 12, 2021

tapadipti commented May 12, 2021

tapadipti commented May 12, 2021

iesahin left a comment

Choose a reason for hiding this comment

tapadipti commented May 12, 2021

jorgeorpinel left a 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

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 May 12, 2021 •

edited

Loading

casperdcl May 11, 2021 •

edited

Loading

arcticbear May 11, 2021 •

edited

Loading